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
# Extract the original non-method undecorated
1115
# function by black magic
925
# Extract the original non-method function by
926
# black magic
1116
927
nonmethod_func = (dict(
1117
zip(attribute.func_code.co_freevars,
1118
attribute.__closure__))
1119
["func"].cell_contents)
928
zip(attribute.func_code.co_freevars,
929
attribute.__closure__))["func"]
930
.cell_contents)
1120
931
# Create a new, but exactly alike, function
1121
932
# object, and decorate it to be a new D-Bus signal
1122
933
# with the alternate D-Bus interface name
1123
new_function = (dbus.service.signal(
1124
alt_interface, attribute._dbus_signature)
934
new_function = (dbus.service.signal
935
(alt_interface,
936
attribute._dbus_signature)
1125
937
(types.FunctionType(
1126
nonmethod_func.func_code,
1127
nonmethod_func.func_globals,
1128
nonmethod_func.func_name,
1129
nonmethod_func.func_defaults,
1130
nonmethod_func.func_closure)))
1131
# Copy annotations, if any
1132
try:
1133
new_function._dbus_annotations = dict(
1134
attribute._dbus_annotations)
1135
except AttributeError:
1136
pass
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)))
1137
943
# Define a creator of a function to call both the
1138
# original and alternate functions, so both the
1139
# original and alternate signals gets sent when
1140
# the function is called
944
# old and new functions, so both the old and new
945
# signals gets sent when the function is called
1141
946
def fixscope(func1, func2):
1142
947
"""This function is a scope container to pass
1143
948
func1 and func2 to the "call_both" function
1144
949
outside of its arguments"""
1145
1146
950
def call_both(*args, **kwargs):
1147
951
"""This function will emit two D-Bus
1148
952
signals by calling func1 and func2"""
1149
953
func1(*args, **kwargs)
1150
954
func2(*args, **kwargs)
1151
1152
955
return call_both
1153
956
# Create the "call_both" function and add it to
1154
957
# the class
1155
attr[attrname] = fixscope(attribute, new_function)
958
attr[attrname] = fixscope(attribute,
959
new_function)
1156
960
# Is this a D-Bus method?
1157
961
elif getattr(attribute, "_dbus_is_method", False):
1158
962
# Create a new, but exactly alike, function
1159
963
# object. Decorate it to be a new D-Bus method
1160
964
# with the alternate D-Bus interface name. Add it
1161
965
# to the class.
1162
attr[attrname] = (
1163
dbus.service.method(
1164
alt_interface,
1165
attribute._dbus_in_signature,
1166
attribute._dbus_out_signature)
1167
(types.FunctionType(attribute.func_code,
1168
attribute.func_globals,
1169
attribute.func_name,
1170
attribute.func_defaults,
1171
attribute.func_closure)))
1172
# Copy annotations, if any
1173
try:
1174
attr[attrname]._dbus_annotations = dict(
1175
attribute._dbus_annotations)
1176
except AttributeError:
1177
pass
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)))
1178
976
# Is this a D-Bus property?
1179
977
elif getattr(attribute, "_dbus_is_property", False):
1180
978
# Create a new, but exactly alike, function
1181
979
# object, and decorate it to be a new D-Bus
1182
980
# property with the alternate D-Bus interface
1183
981
# name. Add it to the class.
1184
attr[attrname] = (dbus_service_property(
1185
alt_interface, attribute._dbus_signature,
1186
attribute._dbus_access,
1187
attribute._dbus_get_args_options
1188
["byte_arrays"])
1189
(types.FunctionType(
1190
attribute.func_code,
1191
attribute.func_globals,
1192
attribute.func_name,
1193
attribute.func_defaults,
1194
attribute.func_closure)))
1195
# Copy annotations, if any
1196
try:
1197
attr[attrname]._dbus_annotations = dict(
1198
attribute._dbus_annotations)
1199
except AttributeError:
1200
pass
1201
# Is this a D-Bus interface?
1202
elif getattr(attribute, "_dbus_is_interface", False):
1203
# Create a new, but exactly alike, function
1204
# object. Decorate it to be a new D-Bus interface
1205
# with the alternate D-Bus interface name. Add it
1206
# to the class.
1207
attr[attrname] = (
1208
dbus_interface_annotations(alt_interface)
1209
(types.FunctionType(attribute.func_code,
1210
attribute.func_globals,
1211
attribute.func_name,
1212
attribute.func_defaults,
1213
attribute.func_closure)))
1214
if deprecate:
1215
# Deprecate all alternate interfaces
1216
iname="_AlternateDBusNames_interface_annotation{}"
1217
for interface_name in interface_names:
1218
1219
@dbus_interface_annotations(interface_name)
1220
def func(self):
1221
return { "org.freedesktop.DBus.Deprecated":
1222
"true" }
1223
# Find an unused name
1224
for aname in (iname.format(i)
1225
for i in itertools.count()):
1226
if aname not in attr:
1227
attr[aname] = func
1228
break
1229
if interface_names:
1230
# Replace the class with a new subclass of it with
1231
# methods, signals, etc. as created above.
1232
cls = type(b"{}Alternate".format(cls.__name__),
1233
(cls, ), attr)
1234
return cls
1235
1236
return wrapper
1237
1238
1239
@alternate_dbus_interfaces({"se.recompile.Mandos":
1240
"se.bsnet.fukt.Mandos"})
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
1241
998
class ClientDBus(Client, DBusObjectWithProperties):
1242
999
"""A Client class using D-Bus
1243
1000
1247
1004
"""
1248
1005
1249
1006
runtime_expansions = (Client.runtime_expansions
1250
+ ("dbus_object_path", ))
1251
1252
_interface = "se.recompile.Mandos.Client"
1007
+ ("dbus_object_path",))
1253
1008
1254
1009
# dbus.service.Object doesn't use super(), so we can't either.
1255
1010
1256
1011
def __init__(self, bus = None, *args, **kwargs):
1257
1012
self.bus = bus
1258
1013
Client.__init__(self, *args, **kwargs)
1014
1015
self._approvals_pending = 0
1259
1016
# Only now, when this client is initialized, can it show up on
1260
1017
# the D-Bus
1261
client_object_name = str(self.name).translate(
1018
client_object_name = unicode(self.name).translate(
1262
1019
{ord("."): ord("_"),
1263
1020
ord("-"): ord("_")})
1264
self.dbus_object_path = dbus.ObjectPath(
1265
"/clients/" + client_object_name)
1021
self.dbus_object_path = (dbus.ObjectPath
1022
("/clients/" + client_object_name))
1266
1023
DBusObjectWithProperties.__init__(self, self.bus,
1267
1024
self.dbus_object_path)
1268
1269
def notifychangeproperty(transform_func, dbus_name,
1270
type_func=lambda x: x,
1271
variant_level=1,
1272
invalidate_only=False,
1273
_interface=_interface):
1025
1026
def notifychangeproperty(transform_func,
1027
dbus_name, type_func=lambda x: x,
1028
variant_level=1):
1274
1029
""" Modify a variable so that it's a property which announces
1275
1030
its changes to DBus.
1276
1031
1281
1036
to the D-Bus. Default: no transform
1282
1037
variant_level: D-Bus variant level. Default: 1
1283
1038
"""
1284
attrname = "_{}".format(dbus_name)
1285
1039
attrname = "_{0}".format(dbus_name)
1286
1040
def setter(self, value):
1287
1041
if hasattr(self, "dbus_object_path"):
1288
1042
if (not hasattr(self, attrname) or
1289
1043
type_func(getattr(self, attrname, None))
1290
1044
!= type_func(value)):
1291
if invalidate_only:
1292
self.PropertiesChanged(
1293
_interface, dbus.Dictionary(),
1294
dbus.Array((dbus_name, )))
1295
else:
1296
dbus_value = transform_func(
1297
type_func(value),
1298
variant_level = variant_level)
1299
self.PropertyChanged(dbus.String(dbus_name),
1300
dbus_value)
1301
self.PropertiesChanged(
1302
_interface,
1303
dbus.Dictionary({ dbus.String(dbus_name):
1304
dbus_value }),
1305
dbus.Array())
1045
dbus_value = transform_func(type_func(value),
1046
variant_level
1047
=variant_level)
1048
self.PropertyChanged(dbus.String(dbus_name),
1049
dbus_value)
1306
1050
setattr(self, attrname, value)
1307
1051
1308
1052
return property(lambda self: getattr(self, attrname), setter)
1309
1053
1054
1310
1055
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1311
1056
approvals_pending = notifychangeproperty(dbus.Boolean,
1312
1057
"ApprovalPending",
1314
1059
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1315
1060
last_enabled = notifychangeproperty(datetime_to_dbus,
1316
1061
"LastEnabled")
1317
checker = notifychangeproperty(
1318
dbus.Boolean, "CheckerRunning",
1319
type_func = lambda checker: checker is not None)
1062
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1063
type_func = lambda checker:
1064
checker is not None)
1320
1065
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1321
1066
"LastCheckedOK")
1322
last_checker_status = notifychangeproperty(dbus.Int16,
1323
"LastCheckerStatus")
1324
1067
last_approval_request = notifychangeproperty(
1325
1068
datetime_to_dbus, "LastApprovalRequest")
1326
1069
approved_by_default = notifychangeproperty(dbus.Boolean,
1327
1070
"ApprovedByDefault")
1328
approval_delay = notifychangeproperty(
1329
dbus.UInt64, "ApprovalDelay",
1330
type_func = lambda td: td.total_seconds() * 1000)
1071
approval_delay = notifychangeproperty(dbus.UInt16,
1072
"ApprovalDelay",
1073
type_func =
1074
_timedelta_to_milliseconds)
1331
1075
approval_duration = notifychangeproperty(
1332
dbus.UInt64, "ApprovalDuration",
1333
type_func = lambda td: td.total_seconds() * 1000)
1076
dbus.UInt16, "ApprovalDuration",
1077
type_func = _timedelta_to_milliseconds)
1334
1078
host = notifychangeproperty(dbus.String, "Host")
1335
timeout = notifychangeproperty(
1336
dbus.UInt64, "Timeout",
1337
type_func = lambda td: td.total_seconds() * 1000)
1079
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1080
type_func =
1081
_timedelta_to_milliseconds)
1338
1082
extended_timeout = notifychangeproperty(
1339
dbus.UInt64, "ExtendedTimeout",
1340
type_func = lambda td: td.total_seconds() * 1000)
1341
interval = notifychangeproperty(
1342
dbus.UInt64, "Interval",
1343
type_func = lambda td: td.total_seconds() * 1000)
1083
dbus.UInt16, "ExtendedTimeout",
1084
type_func = _timedelta_to_milliseconds)
1085
interval = notifychangeproperty(dbus.UInt16,
1086
"Interval",
1087
type_func =
1088
_timedelta_to_milliseconds)
1344
1089
checker_command = notifychangeproperty(dbus.String, "Checker")
1345
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1346
invalidate_only=True)
1347
1090
1348
1091
del notifychangeproperty
1349
1092
1376
1119
*args, **kwargs)
1377
1120
1378
1121
def start_checker(self, *args, **kwargs):
1379
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
1380
1127
r = Client.start_checker(self, *args, **kwargs)
1381
1128
# Only if new checker process was started
1382
1129
if (self.checker is not None
1386
1133
return r
1387
1134
1388
1135
def _reset_approved(self):
1389
self.approved = None
1136
self._approved = None
1390
1137
return False
1391
1138
1392
1139
def approve(self, value=True):
1393
self.approved = value
1394
gobject.timeout_add(int(self.approval_duration.total_seconds()
1395
* 1000), self._reset_approved)
1396
1140
self.send_changedstate()
1141
self._approved = value
1142
gobject.timeout_add(_timedelta_to_milliseconds
1143
(self.approval_duration),
1144
self._reset_approved)
1145
1397
1146
1398
1147
## D-Bus methods, signals & properties
1399
1400
## Interfaces
1148
_interface = "se.recompile.Mandos.Client"
1401
1149
1402
1150
## Signals
1403
1151
1414
1162
pass
1415
1163
1416
1164
# PropertyChanged - signal
1417
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1418
1165
@dbus.service.signal(_interface, signature="sv")
1419
1166
def PropertyChanged(self, property, value):
1420
1167
"D-Bus signal"
1441
1188
"D-Bus signal"
1442
1189
return self.need_approval()
1443
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
1444
1199
## Methods
1445
1200
1446
1201
# Approve - method
1484
1239
return dbus.Boolean(bool(self.approvals_pending))
1485
1240
1486
1241
# ApprovedByDefault - property
1487
@dbus_service_property(_interface,
1488
signature="b",
1242
@dbus_service_property(_interface, signature="b",
1489
1243
access="readwrite")
1490
1244
def ApprovedByDefault_dbus_property(self, value=None):
1491
1245
if value is None: # get
1493
1247
self.approved_by_default = bool(value)
1494
1248
1495
1249
# ApprovalDelay - property
1496
@dbus_service_property(_interface,
1497
signature="t",
1250
@dbus_service_property(_interface, signature="t",
1498
1251
access="readwrite")
1499
1252
def ApprovalDelay_dbus_property(self, value=None):
1500
1253
if value is None: # get
1501
return dbus.UInt64(self.approval_delay.total_seconds()
1502
* 1000)
1254
return dbus.UInt64(self.approval_delay_milliseconds())
1503
1255
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1504
1256
1505
1257
# ApprovalDuration - property
1506
@dbus_service_property(_interface,
1507
signature="t",
1258
@dbus_service_property(_interface, signature="t",
1508
1259
access="readwrite")
1509
1260
def ApprovalDuration_dbus_property(self, value=None):
1510
1261
if value is None: # get
1511
return dbus.UInt64(self.approval_duration.total_seconds()
1512
* 1000)
1262
return dbus.UInt64(_timedelta_to_milliseconds(
1263
self.approval_duration))
1513
1264
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1514
1265
1515
1266
# Name - property
1523
1274
return dbus.String(self.fingerprint)
1524
1275
1525
1276
# Host - property
1526
@dbus_service_property(_interface,
1527
signature="s",
1277
@dbus_service_property(_interface, signature="s",
1528
1278
access="readwrite")
1529
1279
def Host_dbus_property(self, value=None):
1530
1280
if value is None: # get
1531
1281
return dbus.String(self.host)
1532
self.host = str(value)
1282
self.host = value
1533
1283
1534
1284
# Created - property
1535
1285
@dbus_service_property(_interface, signature="s", access="read")
1542
1292
return datetime_to_dbus(self.last_enabled)
1543
1293
1544
1294
# Enabled - property
1545
@dbus_service_property(_interface,
1546
signature="b",
1295
@dbus_service_property(_interface, signature="b",
1547
1296
access="readwrite")
1548
1297
def Enabled_dbus_property(self, value=None):
1549
1298
if value is None: # get
1554
1303
self.disable()
1555
1304
1556
1305
# LastCheckedOK - property
1557
@dbus_service_property(_interface,
1558
signature="s",
1306
@dbus_service_property(_interface, signature="s",
1559
1307
access="readwrite")
1560
1308
def LastCheckedOK_dbus_property(self, value=None):
1561
1309
if value is not None:
1563
1311
return
1564
1312
return datetime_to_dbus(self.last_checked_ok)
1565
1313
1566
# LastCheckerStatus - property
1567
@dbus_service_property(_interface, signature="n", access="read")
1568
def LastCheckerStatus_dbus_property(self):
1569
return dbus.Int16(self.last_checker_status)
1570
1571
1314
# Expires - property
1572
1315
@dbus_service_property(_interface, signature="s", access="read")
1573
1316
def Expires_dbus_property(self):
1579
1322
return datetime_to_dbus(self.last_approval_request)
1580
1323
1581
1324
# Timeout - property
1582
@dbus_service_property(_interface,
1583
signature="t",
1325
@dbus_service_property(_interface, signature="t",
1584
1326
access="readwrite")
1585
1327
def Timeout_dbus_property(self, value=None):
1586
1328
if value is None: # get
1587
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1588
old_timeout = self.timeout
1329
return dbus.UInt64(self.timeout_milliseconds())
1589
1330
self.timeout = datetime.timedelta(0, 0, 0, value)
1590
# Reschedule disabling
1591
if self.enabled:
1592
now = datetime.datetime.utcnow()
1593
self.expires += self.timeout - old_timeout
1594
if self.expires <= now:
1595
# The timeout has passed
1596
self.disable()
1597
else:
1598
if (getattr(self, "disable_initiator_tag", None)
1599
is None):
1600
return
1601
gobject.source_remove(self.disable_initiator_tag)
1602
self.disable_initiator_tag = gobject.timeout_add(
1603
int((self.expires - now).total_seconds() * 1000),
1604
self.disable)
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))
1605
1351
1606
1352
# ExtendedTimeout - property
1607
@dbus_service_property(_interface,
1608
signature="t",
1353
@dbus_service_property(_interface, signature="t",
1609
1354
access="readwrite")
1610
1355
def ExtendedTimeout_dbus_property(self, value=None):
1611
1356
if value is None: # get
1612
return dbus.UInt64(self.extended_timeout.total_seconds()
1613
* 1000)
1357
return dbus.UInt64(self.extended_timeout_milliseconds())
1614
1358
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1615
1359
1616
1360
# Interval - property
1617
@dbus_service_property(_interface,
1618
signature="t",
1361
@dbus_service_property(_interface, signature="t",
1619
1362
access="readwrite")
1620
1363
def Interval_dbus_property(self, value=None):
1621
1364
if value is None: # get
1622
return dbus.UInt64(self.interval.total_seconds() * 1000)
1365
return dbus.UInt64(self.interval_milliseconds())
1623
1366
self.interval = datetime.timedelta(0, 0, 0, value)
1624
1367
if getattr(self, "checker_initiator_tag", None) is None:
1625
1368
return
1626
1369
if self.enabled:
1627
1370
# Reschedule checker run
1628
1371
gobject.source_remove(self.checker_initiator_tag)
1629
self.checker_initiator_tag = gobject.timeout_add(
1630
value, self.start_checker)
1631
self.start_checker() # Start one now, too
1372
self.checker_initiator_tag = (gobject.timeout_add
1373
(value, self.start_checker))
1374
self.start_checker() # Start one now, too
1632
1375
1633
1376
# Checker - property
1634
@dbus_service_property(_interface,
1635
signature="s",
1377
@dbus_service_property(_interface, signature="s",
1636
1378
access="readwrite")
1637
1379
def Checker_dbus_property(self, value=None):
1638
1380
if value is None: # get
1639
1381
return dbus.String(self.checker_command)
1640
self.checker_command = str(value)
1382
self.checker_command = value
1641
1383
1642
1384
# CheckerRunning - property
1643
@dbus_service_property(_interface,
1644
signature="b",
1385
@dbus_service_property(_interface, signature="b",
1645
1386
access="readwrite")
1646
1387
def CheckerRunning_dbus_property(self, value=None):
1647
1388
if value is None: # get
1657
1398
return self.dbus_object_path # is already a dbus.ObjectPath
1658
1399
1659
1400
# Secret = property
1660
@dbus_service_property(_interface,
1661
signature="ay",
1662
access="write",
1663
byte_arrays=True)
1401
@dbus_service_property(_interface, signature="ay",
1402
access="write", byte_arrays=True)
1664
1403
def Secret_dbus_property(self, value):
1665
self.secret = bytes(value)
1404
self.secret = str(value)
1666
1405
1667
1406
del _interface
1668
1407
1675
1414
raise KeyError()
1676
1415
1677
1416
def __getattribute__(self, name):
1678
if name == '_pipe':
1417
if(name == '_pipe'):
1679
1418
return super(ProxyClient, self).__getattribute__(name)
1680
1419
self._pipe.send(('getattr', name))
1681
1420
data = self._pipe.recv()
1682
1421
if data[0] == 'data':
1683
1422
return data[1]
1684
1423
if data[0] == 'function':
1685
1686
1424
def func(*args, **kwargs):
1687
1425
self._pipe.send(('funcall', name, args, kwargs))
1688
1426
return self._pipe.recv()[1]
1689
1690
1427
return func
1691
1428
1692
1429
def __setattr__(self, name, value):
1693
if name == '_pipe':
1430
if(name == '_pipe'):
1694
1431
return super(ProxyClient, self).__setattr__(name, value)
1695
1432
self._pipe.send(('setattr', name, value))
1696
1433
1697
1434
1435
class ClientDBusTransitional(ClientDBus):
1436
__metaclass__ = AlternateDBusNamesMetaclass
1437
1438
1698
1439
class ClientHandler(socketserver.BaseRequestHandler, object):
1699
1440
"""A class to handle client connections.
1700
1441
1704
1445
def handle(self):
1705
1446
with contextlib.closing(self.server.child_pipe) as child_pipe:
1706
1447
logger.info("TCP connection from: %s",
1707
str(self.client_address))
1448
unicode(self.client_address))
1708
1449
logger.debug("Pipe FD: %d",
1709
1450
self.server.child_pipe.fileno())
1710
1451
1711
session = gnutls.connection.ClientSession(
1712
self.request, gnutls.connection .X509Credentials())
1452
session = (gnutls.connection
1453
.ClientSession(self.request,
1454
gnutls.connection
1455
.X509Credentials()))
1713
1456
1714
1457
# Note: gnutls.connection.X509Credentials is really a
1715
1458
# generic GnuTLS certificate credentials object so long as
1724
1467
priority = self.server.gnutls_priority
1725
1468
if priority is None:
1726
1469
priority = "NORMAL"
1727
gnutls.library.functions.gnutls_priority_set_direct(
1728
session._c_object, priority, None)
1470
(gnutls.library.functions
1471
.gnutls_priority_set_direct(session._c_object,
1472
priority, None))
1729
1473
1730
1474
# Start communication using the Mandos protocol
1731
1475
# Get protocol number
1733
1477
logger.debug("Protocol version: %r", line)
1734
1478
try:
1735
1479
if int(line.strip().split()[0]) > 1:
1736
raise RuntimeError(line)
1480
raise RuntimeError
1737
1481
except (ValueError, IndexError, RuntimeError) as error:
1738
1482
logger.error("Unknown protocol version: %s", error)
1739
1483
return
1751
1495
approval_required = False
1752
1496
try:
1753
1497
try:
1754
fpr = self.fingerprint(
1755
self.peer_certificate(session))
1498
fpr = self.fingerprint(self.peer_certificate
1499
(session))
1756
1500
except (TypeError,
1757
1501
gnutls.errors.GNUTLSError) as error:
1758
1502
logger.warning("Bad certificate: %s", error)
1759
1503
return
1760
1504
logger.debug("Fingerprint: %s", fpr)
1505
if self.server.use_dbus:
1506
# Emit D-Bus signal
1507
client.NewRequest(str(self.client_address))
1761
1508
1762
1509
try:
1763
1510
client = ProxyClient(child_pipe, fpr,
1773
1520
while True:
1774
1521
if not client.enabled:
1775
1522
logger.info("Client %s is disabled",
1776
client.name)
1523
client.name)
1777
1524
if self.server.use_dbus:
1778
1525
# Emit D-Bus signal
1779
1526
client.Rejected("Disabled")
1780
1527
return
1781
1528
1782
if client.approved or not client.approval_delay:
1529
if client._approved or not client.approval_delay:
1783
1530
#We are approved or approval is disabled
1784
1531
break
1785
elif client.approved is None:
1532
elif client._approved is None:
1786
1533
logger.info("Client %s needs approval",
1787
1534
client.name)
1788
1535
if self.server.use_dbus:
1789
1536
# Emit D-Bus signal
1790
1537
client.NeedApproval(
1791
client.approval_delay.total_seconds()
1792
* 1000, client.approved_by_default)
1538
client.approval_delay_milliseconds(),
1539
client.approved_by_default)
1793
1540
else:
1794
1541
logger.warning("Client %s was not approved",
1795
1542
client.name)
1801
1548
#wait until timeout or approved
1802
1549
time = datetime.datetime.now()
1803
1550
client.changedstate.acquire()
1804
client.changedstate.wait(delay.total_seconds())
1551
(client.changedstate.wait
1552
(float(client._timedelta_to_milliseconds(delay)
1553
/ 1000)))
1805
1554
client.changedstate.release()
1806
1555
time2 = datetime.datetime.now()
1807
1556
if (time2 - time) >= delay:
1823
1572
try:
1824
1573
sent = session.send(client.secret[sent_size:])
1825
1574
except gnutls.errors.GNUTLSError as error:
1826
logger.warning("gnutls send failed",
1827
exc_info=error)
1575
logger.warning("gnutls send failed")
1828
1576
return
1829
logger.debug("Sent: %d, remaining: %d", sent,
1830
len(client.secret) - (sent_size
1831
+ sent))
1577
logger.debug("Sent: %d, remaining: %d",
1578
sent, len(client.secret)
1579
- (sent_size + sent))
1832
1580
sent_size += sent
1833
1581
1834
1582
logger.info("Sending secret to %s", client.name)
1835
1583
# bump the timeout using extended_timeout
1836
client.bump_timeout(client.extended_timeout)
1584
client.checked_ok(client.extended_timeout)
1837
1585
if self.server.use_dbus:
1838
1586
# Emit D-Bus signal
1839
1587
client.GotSecret()
1844
1592
try:
1845
1593
session.bye()
1846
1594
except gnutls.errors.GNUTLSError as error:
1847
logger.warning("GnuTLS bye failed",
1848
exc_info=error)
1595
logger.warning("GnuTLS bye failed")
1849
1596
1850
1597
@staticmethod
1851
1598
def peer_certificate(session):
1852
1599
"Return the peer's OpenPGP certificate as a bytestring"
1853
1600
# If not an OpenPGP certificate...
1854
if (gnutls.library.functions.gnutls_certificate_type_get(
1855
session._c_object)
1601
if (gnutls.library.functions
1602
.gnutls_certificate_type_get(session._c_object)
1856
1603
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1857
1604
# ...do the normal thing
1858
1605
return session.peer_certificate
1872
1619
def fingerprint(openpgp):
1873
1620
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1874
1621
# New GnuTLS "datum" with the OpenPGP public key
1875
datum = gnutls.library.types.gnutls_datum_t(
1876
ctypes.cast(ctypes.c_char_p(openpgp),
1877
ctypes.POINTER(ctypes.c_ubyte)),
1878
ctypes.c_uint(len(openpgp)))
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))))
1879
1627
# New empty GnuTLS certificate
1880
1628
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1881
gnutls.library.functions.gnutls_openpgp_crt_init(
1882
ctypes.byref(crt))
1629
(gnutls.library.functions
1630
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1883
1631
# Import the OpenPGP public key into the certificate
1884
gnutls.library.functions.gnutls_openpgp_crt_import(
1885
crt, ctypes.byref(datum),
1886
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
1632
(gnutls.library.functions
1633
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1634
gnutls.library.constants
1635
.GNUTLS_OPENPGP_FMT_RAW))
1887
1636
# Verify the self signature in the key
1888
1637
crtverify = ctypes.c_uint()
1889
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1890
crt, 0, ctypes.byref(crtverify))
1638
(gnutls.library.functions
1639
.gnutls_openpgp_crt_verify_self(crt, 0,
1640
ctypes.byref(crtverify)))
1891
1641
if crtverify.value != 0:
1892
1642
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1893
raise gnutls.errors.CertificateSecurityError(
1894
"Verify failed")
1643
raise (gnutls.errors.CertificateSecurityError
1644
("Verify failed"))
1895
1645
# New buffer for the fingerprint
1896
1646
buf = ctypes.create_string_buffer(20)
1897
1647
buf_len = ctypes.c_size_t()
1898
1648
# Get the fingerprint from the certificate into the buffer
1899
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1900
crt, ctypes.byref(buf), ctypes.byref(buf_len))
1649
(gnutls.library.functions
1650
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1651
ctypes.byref(buf_len)))
1901
1652
# Deinit the certificate
1902
1653
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1903
1654
# Convert the buffer to a Python bytestring
1909
1660
1910
1661
class MultiprocessingMixIn(object):
1911
1662
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1912
1913
1663
def sub_process_main(self, request, address):
1914
1664
try:
1915
1665
self.finish_request(request, address)
1916
except Exception:
1666
except:
1917
1667
self.handle_error(request, address)
1918
1668
self.close_request(request)
1919
1669
1920
1670
def process_request(self, request, address):
1921
1671
"""Start a new process to process the request."""
1922
1672
proc = multiprocessing.Process(target = self.sub_process_main,
1923
args = (request, address))
1673
args = (request,
1674
address))
1924
1675
proc.start()
1925
1676
return proc
1926
1677
1927
1678
1928
1679
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1929
1680
""" adds a pipe to the MixIn """
1930
1931
1681
def process_request(self, request, client_address):
1932
1682
"""Overrides and wraps the original process_request().
1933
1683
1942
1692
1943
1693
def add_pipe(self, parent_pipe, proc):
1944
1694
"""Dummy function; override as necessary"""
1945
raise NotImplementedError()
1695
raise NotImplementedError
1946
1696
1947
1697
1948
1698
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1954
1704
interface: None or a network interface name (string)
1955
1705
use_ipv6: Boolean; to use IPv6 or not
1956
1706
"""
1957
1958
1707
def __init__(self, server_address, RequestHandlerClass,
1959
interface=None,
1960
use_ipv6=True,
1961
socketfd=None):
1962
"""If socketfd is set, use that file descriptor instead of
1963
creating a new one with socket.socket().
1964
"""
1708
interface=None, use_ipv6=True):
1965
1709
self.interface = interface
1966
1710
if use_ipv6:
1967
1711
self.address_family = socket.AF_INET6
1968
if socketfd is not None:
1969
# Save the file descriptor
1970
self.socketfd = socketfd
1971
# Save the original socket.socket() function
1972
self.socket_socket = socket.socket
1973
# To implement --socket, we monkey patch socket.socket.
1974
#
1975
# (When socketserver.TCPServer is a new-style class, we
1976
# could make self.socket into a property instead of monkey
1977
# patching socket.socket.)
1978
#
1979
# Create a one-time-only replacement for socket.socket()
1980
@functools.wraps(socket.socket)
1981
def socket_wrapper(*args, **kwargs):
1982
# Restore original function so subsequent calls are
1983
# not affected.
1984
socket.socket = self.socket_socket
1985
del self.socket_socket
1986
# This time only, return a new socket object from the
1987
# saved file descriptor.
1988
return socket.fromfd(self.socketfd, *args, **kwargs)
1989
# Replace socket.socket() function with wrapper
1990
socket.socket = socket_wrapper
1991
# The socketserver.TCPServer.__init__ will call
1992
# socket.socket(), which might be our replacement,
1993
# socket_wrapper(), if socketfd was set.
1994
1712
socketserver.TCPServer.__init__(self, server_address,
1995
1713
RequestHandlerClass)
1996
1997
1714
def server_bind(self):
1998
1715
"""This overrides the normal server_bind() function
1999
1716
to bind to an interface if one was specified, and also NOT to
2005
1722
self.interface)
2006
1723
else:
2007
1724
try:
2008
self.socket.setsockopt(
2009
socket.SOL_SOCKET, SO_BINDTODEVICE,
2010
(self.interface + "\0").encode("utf-8"))
1725
self.socket.setsockopt(socket.SOL_SOCKET,
1726
SO_BINDTODEVICE,
1727
str(self.interface
1728
+ '\0'))
2011
1729
except socket.error as error:
2012
if error.errno == errno.EPERM:
2013
logger.error("No permission to bind to"
2014
" interface %s", self.interface)
2015
elif error.errno == errno.ENOPROTOOPT:
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:
2016
1735
logger.error("SO_BINDTODEVICE not available;"
2017
1736
" cannot bind to interface %s",
2018
1737
self.interface)
2019
elif error.errno == errno.ENODEV:
2020
logger.error("Interface %s does not exist,"
2021
" cannot bind", self.interface)
2022
1738
else:
2023
1739
raise
2024
1740
# Only bind(2) the socket if we really need to.
2027
1743
if self.address_family == socket.AF_INET6:
2028
1744
any_address = "::" # in6addr_any
2029
1745
else:
2030
any_address = "0.0.0.0" # INADDR_ANY
1746
any_address = socket.INADDR_ANY
2031
1747
self.server_address = (any_address,
2032
1748
self.server_address[1])
2033
1749
elif not self.server_address[1]:
2034
self.server_address = (self.server_address[0], 0)
1750
self.server_address = (self.server_address[0],
1751
0)
2035
1752
# if self.interface:
2036
1753
# self.server_address = (self.server_address[0],
2037
1754
# 0, # port
2051
1768
2052
1769
Assumes a gobject.MainLoop event loop.
2053
1770
"""
2054
2055
1771
def __init__(self, server_address, RequestHandlerClass,
2056
interface=None,
2057
use_ipv6=True,
2058
clients=None,
2059
gnutls_priority=None,
2060
use_dbus=True,
2061
socketfd=None):
1772
interface=None, use_ipv6=True, clients=None,
1773
gnutls_priority=None, use_dbus=True):
2062
1774
self.enabled = False
2063
1775
self.clients = clients
2064
1776
if self.clients is None:
2068
1780
IPv6_TCPServer.__init__(self, server_address,
2069
1781
RequestHandlerClass,
2070
1782
interface = interface,
2071
use_ipv6 = use_ipv6,
2072
socketfd = socketfd)
2073
1783
use_ipv6 = use_ipv6)
2074
1784
def server_activate(self):
2075
1785
if self.enabled:
2076
1786
return socketserver.TCPServer.server_activate(self)
2080
1790
2081
1791
def add_pipe(self, parent_pipe, proc):
2082
1792
# Call "handle_ipc" for both data and EOF events
2083
gobject.io_add_watch(
2084
parent_pipe.fileno(),
2085
gobject.IO_IN | gobject.IO_HUP,
2086
functools.partial(self.handle_ipc,
2087
parent_pipe = parent_pipe,
2088
proc = proc))
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))
2089
1799
2090
def handle_ipc(self, source, condition,
2091
parent_pipe=None,
2092
proc = None,
2093
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)
2094
1816
# error, or the other end of multiprocessing.Pipe has closed
2095
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1817
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2096
1818
# Wait for other process to exit
2097
1819
proc.join()
2098
1820
return False
2119
1841
parent_pipe.send(False)
2120
1842
return False
2121
1843
2122
gobject.io_add_watch(
2123
parent_pipe.fileno(),
2124
gobject.IO_IN | gobject.IO_HUP,
2125
functools.partial(self.handle_ipc,
2126
parent_pipe = parent_pipe,
2127
proc = proc,
2128
client_object = client))
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))
2129
1852
parent_pipe.send(True)
2130
1853
# remove the old hook in favor of the new above hook on
2131
1854
# same fileno
2137
1860
2138
1861
parent_pipe.send(('data', getattr(client_object,
2139
1862
funcname)(*args,
2140
**kwargs)))
1863
**kwargs)))
2141
1864
2142
1865
if command == 'getattr':
2143
1866
attrname = request[1]
2144
1867
if callable(client_object.__getattribute__(attrname)):
2145
parent_pipe.send(('function', ))
1868
parent_pipe.send(('function',))
2146
1869
else:
2147
parent_pipe.send((
2148
'data', client_object.__getattribute__(attrname)))
1870
parent_pipe.send(('data', client_object
1871
.__getattribute__(attrname)))
2149
1872
2150
1873
if command == 'setattr':
2151
1874
attrname = request[1]
2155
1878
return True
2156
1879
2157
1880
2158
def rfc3339_duration_to_delta(duration):
2159
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2160
2161
>>> rfc3339_duration_to_delta("P7D")
2162
datetime.timedelta(7)
2163
>>> rfc3339_duration_to_delta("PT60S")
2164
datetime.timedelta(0, 60)
2165
>>> rfc3339_duration_to_delta("PT60M")
2166
datetime.timedelta(0, 3600)
2167
>>> rfc3339_duration_to_delta("PT24H")
2168
datetime.timedelta(1)
2169
>>> rfc3339_duration_to_delta("P1W")
2170
datetime.timedelta(7)
2171
>>> rfc3339_duration_to_delta("PT5M30S")
2172
datetime.timedelta(0, 330)
2173
>>> rfc3339_duration_to_delta("P1DT3M20S")
2174
datetime.timedelta(1, 200)
2175
"""
2176
2177
# Parsing an RFC 3339 duration with regular expressions is not
2178
# possible - there would have to be multiple places for the same
2179
# values, like seconds. The current code, while more esoteric, is
2180
# cleaner without depending on a parsing library. If Python had a
2181
# built-in library for parsing we would use it, but we'd like to
2182
# avoid excessive use of external libraries.
2183
2184
# New type for defining tokens, syntax, and semantics all-in-one
2185
Token = collections.namedtuple("Token",
2186
("regexp", # To match token; if
2187
# "value" is not None,
2188
# must have a "group"
2189
# containing digits
2190
"value", # datetime.timedelta or
2191
# None
2192
"followers")) # Tokens valid after
2193
# this token
2194
Token = collections.namedtuple("Token", (
2195
"regexp", # To match token; if "value" is not None, must have
2196
# a "group" containing digits
2197
"value", # datetime.timedelta or None
2198
"followers")) # Tokens valid after this token
2199
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2200
# the "duration" ABNF definition in RFC 3339, Appendix A.
2201
token_end = Token(re.compile(r"$"), None, frozenset())
2202
token_second = Token(re.compile(r"(\d+)S"),
2203
datetime.timedelta(seconds=1),
2204
frozenset((token_end, )))
2205
token_minute = Token(re.compile(r"(\d+)M"),
2206
datetime.timedelta(minutes=1),
2207
frozenset((token_second, token_end)))
2208
token_hour = Token(re.compile(r"(\d+)H"),
2209
datetime.timedelta(hours=1),
2210
frozenset((token_minute, token_end)))
2211
token_time = Token(re.compile(r"T"),
2212
None,
2213
frozenset((token_hour, token_minute,
2214
token_second)))
2215
token_day = Token(re.compile(r"(\d+)D"),
2216
datetime.timedelta(days=1),
2217
frozenset((token_time, token_end)))
2218
token_month = Token(re.compile(r"(\d+)M"),
2219
datetime.timedelta(weeks=4),
2220
frozenset((token_day, token_end)))
2221
token_year = Token(re.compile(r"(\d+)Y"),
2222
datetime.timedelta(weeks=52),
2223
frozenset((token_month, token_end)))
2224
token_week = Token(re.compile(r"(\d+)W"),
2225
datetime.timedelta(weeks=1),
2226
frozenset((token_end, )))
2227
token_duration = Token(re.compile(r"P"), None,
2228
frozenset((token_year, token_month,
2229
token_day, token_time,
2230
token_week)))
2231
# Define starting values
2232
value = datetime.timedelta() # Value so far
2233
found_token = None
2234
followers = frozenset((token_duration,)) # Following valid tokens
2235
s = duration # String left to parse
2236
# Loop until end token is found
2237
while found_token is not token_end:
2238
# Search for any currently valid tokens
2239
for token in followers:
2240
match = token.regexp.match(s)
2241
if match is not None:
2242
# Token found
2243
if token.value is not None:
2244
# Value found, parse digits
2245
factor = int(match.group(1), 10)
2246
# Add to value so far
2247
value += factor * token.value
2248
# Strip token from string
2249
s = token.regexp.sub("", s, 1)
2250
# Go to found token
2251
found_token = token
2252
# Set valid next tokens
2253
followers = found_token.followers
2254
break
2255
else:
2256
# No currently valid tokens were found
2257
raise ValueError("Invalid RFC 3339 duration")
2258
# End token found
2259
return value
2260
2261
2262
1881
def string_to_delta(interval):
2263
1882
"""Parse a string and return a datetime.timedelta
2264
1883
2275
1894
>>> string_to_delta('5m 30s')
2276
1895
datetime.timedelta(0, 330)
2277
1896
"""
2278
2279
try:
2280
return rfc3339_duration_to_delta(interval)
2281
except ValueError:
2282
pass
2283
2284
1897
timevalue = datetime.timedelta(0)
2285
1898
for s in interval.split():
2286
1899
try:
2287
suffix = s[-1]
1900
suffix = unicode(s[-1])
2288
1901
value = int(s[:-1])
2289
1902
if suffix == "d":
2290
1903
delta = datetime.timedelta(value)
2297
1910
elif suffix == "w":
2298
1911
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2299
1912
else:
2300
raise ValueError("Unknown suffix {!r}".format(suffix))
2301
except IndexError as e:
1913
raise ValueError("Unknown suffix %r" % suffix)
1914
except (ValueError, IndexError) as e:
2302
1915
raise ValueError(*(e.args))
2303
1916
timevalue += delta
2304
1917
return timevalue
2317
1930
sys.exit()
2318
1931
if not noclose:
2319
1932
# Close all standard open file descriptors
2320
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1933
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2321
1934
if not stat.S_ISCHR(os.fstat(null).st_mode):
2322
1935
raise OSError(errno.ENODEV,
2323
"{} not a character device"
2324
.format(os.devnull))
1936
"%s not a character device"
1937
% os.path.devnull)
2325
1938
os.dup2(null, sys.stdin.fileno())
2326
1939
os.dup2(null, sys.stdout.fileno())
2327
1940
os.dup2(null, sys.stderr.fileno())
2336
1949
2337
1950
parser = argparse.ArgumentParser()
2338
1951
parser.add_argument("-v", "--version", action="version",
2339
version = "%(prog)s {}".format(version),
1952
version = "%%(prog)s %s" % version,
2340
1953
help="show version number and exit")
2341
1954
parser.add_argument("-i", "--interface", metavar="IF",
2342
1955
help="Bind to interface IF")
2348
1961
help="Run self-test")
2349
1962
parser.add_argument("--debug", action="store_true",
2350
1963
help="Debug mode; run in foreground and log"
2351
" to terminal", default=None)
1964
" to terminal")
2352
1965
parser.add_argument("--debuglevel", metavar="LEVEL",
2353
1966
help="Debug level for stdout output")
2354
1967
parser.add_argument("--priority", help="GnuTLS"
2361
1974
" files")
2362
1975
parser.add_argument("--no-dbus", action="store_false",
2363
1976
dest="use_dbus", help="Do not provide D-Bus"
2364
" system bus interface", default=None)
1977
" system bus interface")
2365
1978
parser.add_argument("--no-ipv6", action="store_false",
2366
dest="use_ipv6", help="Do not use IPv6",
2367
default=None)
1979
dest="use_ipv6", help="Do not use IPv6")
2368
1980
parser.add_argument("--no-restore", action="store_false",
2369
1981
dest="restore", help="Do not restore stored"
2370
" state", default=None)
2371
parser.add_argument("--socket", type=int,
2372
help="Specify a file descriptor to a network"
2373
" socket to use instead of creating one")
1982
" state")
2374
1983
parser.add_argument("--statedir", metavar="DIR",
2375
1984
help="Directory to save/restore state in")
2376
parser.add_argument("--foreground", action="store_true",
2377
help="Run in foreground", default=None)
2378
parser.add_argument("--no-zeroconf", action="store_false",
2379
dest="zeroconf", help="Do not use Zeroconf",
2380
default=None)
2381
1985
2382
1986
options = parser.parse_args()
2383
1987
2384
1988
if options.check:
2385
1989
import doctest
2386
fail_count, test_count = doctest.testmod()
2387
sys.exit(os.EX_OK if fail_count == 0 else 1)
1990
doctest.testmod()
1991
sys.exit()
2388
1992
2389
1993
# Default values for config file for server-global settings
2390
1994
server_defaults = { "interface": "",
2392
1996
"port": "",
2393
1997
"debug": "False",
2394
1998
"priority":
2395
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2396
":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1999
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2397
2000
"servicename": "Mandos",
2398
2001
"use_dbus": "True",
2399
2002
"use_ipv6": "True",
2400
2003
"debuglevel": "",
2401
2004
"restore": "True",
2402
"socket": "",
2403
"statedir": "/var/lib/mandos",
2404
"foreground": "False",
2405
"zeroconf": "True",
2406
}
2005
"statedir": "/var/lib/mandos"
2006
}
2407
2007
2408
2008
# Parse config file for server-global settings
2409
2009
server_config = configparser.SafeConfigParser(server_defaults)
2410
2010
del server_defaults
2411
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2011
server_config.read(os.path.join(options.configdir,
2012
"mandos.conf"))
2412
2013
# Convert the SafeConfigParser object to a dict
2413
2014
server_settings = server_config.defaults()
2414
2015
# Use the appropriate methods on the non-string config options
2415
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2016
for option in ("debug", "use_dbus", "use_ipv6"):
2416
2017
server_settings[option] = server_config.getboolean("DEFAULT",
2417
2018
option)
2418
2019
if server_settings["port"]:
2419
2020
server_settings["port"] = server_config.getint("DEFAULT",
2420
2021
"port")
2421
if server_settings["socket"]:
2422
server_settings["socket"] = server_config.getint("DEFAULT",
2423
"socket")
2424
# Later, stdin will, and stdout and stderr might, be dup'ed
2425
# over with an opened os.devnull. But we don't want this to
2426
# happen with a supplied network socket.
2427
if 0 <= server_settings["socket"] <= 2:
2428
server_settings["socket"] = os.dup(server_settings
2429
["socket"])
2430
2022
del server_config
2431
2023
2432
2024
# Override the settings from the config file with command line
2433
2025
# options, if set.
2434
2026
for option in ("interface", "address", "port", "debug",
2435
"priority", "servicename", "configdir", "use_dbus",
2436
"use_ipv6", "debuglevel", "restore", "statedir",
2437
"socket", "foreground", "zeroconf"):
2027
"priority", "servicename", "configdir",
2028
"use_dbus", "use_ipv6", "debuglevel", "restore",
2029
"statedir"):
2438
2030
value = getattr(options, option)
2439
2031
if value is not None:
2440
2032
server_settings[option] = value
2441
2033
del options
2442
2034
# Force all strings to be unicode
2443
2035
for option in server_settings.keys():
2444
if isinstance(server_settings[option], bytes):
2445
server_settings[option] = (server_settings[option]
2446
.decode("utf-8"))
2447
# Force all boolean options to be boolean
2448
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2449
"foreground", "zeroconf"):
2450
server_settings[option] = bool(server_settings[option])
2451
# Debug implies foreground
2452
if server_settings["debug"]:
2453
server_settings["foreground"] = True
2036
if type(server_settings[option]) is str:
2037
server_settings[option] = unicode(server_settings[option])
2454
2038
# Now we have our good server settings in "server_settings"
2455
2039
2456
2040
##################################################################
2457
2041
2458
if (not server_settings["zeroconf"]
2459
and not (server_settings["port"]
2460
or server_settings["socket"] != "")):
2461
parser.error("Needs port or socket to work without Zeroconf")
2462
2463
2042
# For convenience
2464
2043
debug = server_settings["debug"]
2465
2044
debuglevel = server_settings["debuglevel"]
2467
2046
use_ipv6 = server_settings["use_ipv6"]
2468
2047
stored_state_path = os.path.join(server_settings["statedir"],
2469
2048
stored_state_file)
2470
foreground = server_settings["foreground"]
2471
zeroconf = server_settings["zeroconf"]
2472
2049
2473
2050
if debug:
2474
initlogger(debug, logging.DEBUG)
2051
initlogger(logging.DEBUG)
2475
2052
else:
2476
2053
if not debuglevel:
2477
initlogger(debug)
2054
initlogger()
2478
2055
else:
2479
2056
level = getattr(logging, debuglevel.upper())
2480
initlogger(debug, level)
2057
initlogger(level)
2481
2058
2482
2059
if server_settings["servicename"] != "Mandos":
2483
syslogger.setFormatter(
2484
logging.Formatter('Mandos ({}) [%(process)d]:'
2485
' %(levelname)s: %(message)s'.format(
2486
server_settings["servicename"])))
2060
syslogger.setFormatter(logging.Formatter
2061
('Mandos (%s) [%%(process)d]:'
2062
' %%(levelname)s: %%(message)s'
2063
% server_settings["servicename"]))
2487
2064
2488
2065
# Parse config file with clients
2489
client_config = configparser.SafeConfigParser(Client
2490
.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)
2491
2075
client_config.read(os.path.join(server_settings["configdir"],
2492
2076
"clients.conf"))
2493
2077
2494
2078
global mandos_dbus_service
2495
2079
mandos_dbus_service = None
2496
2080
2497
socketfd = None
2498
if server_settings["socket"] != "":
2499
socketfd = server_settings["socket"]
2500
tcp_server = MandosServer(
2501
(server_settings["address"], server_settings["port"]),
2502
ClientHandler,
2503
interface=(server_settings["interface"] or None),
2504
use_ipv6=use_ipv6,
2505
gnutls_priority=server_settings["priority"],
2506
use_dbus=use_dbus,
2507
socketfd=socketfd)
2508
if not foreground:
2509
pidfilename = "/run/mandos.pid"
2510
if not os.path.isdir("/run/."):
2511
pidfilename = "/var/run/mandos.pid"
2512
pidfile = None
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"
2513
2092
try:
2514
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2515
except IOError as e:
2516
logger.error("Could not open file %r", pidfilename,
2517
exc_info=e)
2093
pidfile = open(pidfilename, "w")
2094
except IOError:
2095
logger.error("Could not open file %r", pidfilename)
2518
2096
2519
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:
2520
2101
try:
2521
uid = pwd.getpwnam(name).pw_uid
2522
gid = pwd.getpwnam(name).pw_gid
2523
break
2102
uid = pwd.getpwnam("mandos").pw_uid
2103
gid = pwd.getpwnam("mandos").pw_gid
2524
2104
except KeyError:
2525
continue
2526
else:
2527
uid = 65534
2528
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
2529
2111
try:
2530
2112
os.setgid(gid)
2531
2113
os.setuid(uid)
2532
2114
except OSError as error:
2533
if error.errno != errno.EPERM:
2534
raise
2115
if error[0] != errno.EPERM:
2116
raise error
2535
2117
2536
2118
if debug:
2537
2119
# Enable all possible GnuTLS debugging
2544
2126
def debug_gnutls(level, string):
2545
2127
logger.debug("GnuTLS: %s", string[:-1])
2546
2128
2547
gnutls.library.functions.gnutls_global_set_log_function(
2548
debug_gnutls)
2129
(gnutls.library.functions
2130
.gnutls_global_set_log_function(debug_gnutls))
2549
2131
2550
2132
# Redirect stdin so all checkers get /dev/null
2551
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2133
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2552
2134
os.dup2(null, sys.stdin.fileno())
2553
2135
if null > 2:
2554
2136
os.close(null)
2137
else:
2138
# No console logging
2139
logger.removeHandler(console)
2555
2140
2556
2141
# Need to fork before connecting to D-Bus
2557
if not foreground:
2142
if not debug:
2558
2143
# Close all input and output, do double fork, etc.
2559
2144
daemon()
2560
2145
2561
# multiprocessing will use threads, so before we use gobject we
2562
# need to inform gobject that threads will be used.
2563
gobject.threads_init()
2564
2565
2146
global main_loop
2566
2147
# From the Avahi example code
2567
DBusGMainLoop(set_as_default=True)
2148
DBusGMainLoop(set_as_default=True )
2568
2149
main_loop = gobject.MainLoop()
2569
2150
bus = dbus.SystemBus()
2570
2151
# End of Avahi example code
2571
2152
if use_dbus:
2572
2153
try:
2573
2154
bus_name = dbus.service.BusName("se.recompile.Mandos",
2574
bus,
2575
do_not_queue=True)
2576
old_bus_name = dbus.service.BusName(
2577
"se.bsnet.fukt.Mandos", bus,
2578
do_not_queue=True)
2579
except dbus.exceptions.DBusException as e:
2580
logger.error("Disabling D-Bus:", exc_info=e)
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")
2581
2161
use_dbus = False
2582
2162
server_settings["use_dbus"] = False
2583
2163
tcp_server.use_dbus = False
2584
if zeroconf:
2585
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2586
service = AvahiServiceToSyslog(
2587
name = server_settings["servicename"],
2588
servicetype = "_mandos._tcp",
2589
protocol = protocol,
2590
bus = bus)
2591
if server_settings["interface"]:
2592
service.interface = if_nametoindex(
2593
server_settings["interface"].encode("utf-8"))
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"])))
2594
2172
2595
2173
global multiprocessing_manager
2596
2174
multiprocessing_manager = multiprocessing.Manager()
2597
2175
2598
2176
client_class = Client
2599
2177
if use_dbus:
2600
client_class = functools.partial(ClientDBus, bus = bus)
2601
2602
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
2603
2204
old_client_settings = {}
2604
clients_data = {}
2605
2606
# This is used to redirect stdout and stderr for checker processes
2607
global wnull
2608
wnull = open(os.devnull, "w") # A writable /dev/null
2609
# Only used if server is running in foreground but not in debug
2610
# mode
2611
if debug or not foreground:
2612
wnull.close()
2205
clients_data = []
2613
2206
2614
2207
# Get client data and settings from last running state.
2615
2208
if server_settings["restore"]:
2616
2209
try:
2617
2210
with open(stored_state_path, "rb") as stored_state:
2618
clients_data, old_client_settings = pickle.load(
2619
stored_state)
2211
clients_data, old_client_settings = (pickle.load
2212
(stored_state))
2620
2213
os.remove(stored_state_path)
2621
2214
except IOError as e:
2622
if e.errno == errno.ENOENT:
2623
logger.warning("Could not load persistent state:"
2624
" {}".format(os.strerror(e.errno)))
2625
else:
2626
logger.critical("Could not load persistent state:",
2627
exc_info=e)
2215
logger.warning("Could not load persistent state: {0}"
2216
.format(e))
2217
if e.errno != errno.ENOENT:
2628
2218
raise
2629
except EOFError as e:
2630
logger.warning("Could not load persistent state: "
2631
"EOFError:",
2632
exc_info=e)
2633
2219
2634
with PGPEngine() as pgp:
2635
for client_name, client in clients_data.items():
2636
# Skip removed clients
2637
if client_name not in client_settings:
2638
continue
2220
with Crypto() as crypt:
2221
for client in clients_data:
2222
client_name = client["name"]
2639
2223
2640
2224
# Decide which value to use after restoring saved state.
2641
2225
# We have three different values: Old config file,
2647
2231
# For each value in new config, check if it
2648
2232
# differs from the old config value (Except for
2649
2233
# the "secret" attribute)
2650
if (name != "secret"
2651
and (value !=
2652
old_client_settings[client_name][name])):
2653
client[name] = value
2234
if (name != "secret" and
2235
value != old_client_settings[client_name]
2236
[name]):
2237
setattr(client, name, value)
2654
2238
except KeyError:
2655
2239
pass
2656
2240
2657
2241
# Clients who has passed its expire date can still be
2658
# enabled if its last checker was successful. Clients
2659
# whose checker succeeded before we stored its state is
2660
# assumed to have successfully run all checkers during
2661
# downtime.
2662
if client["enabled"]:
2663
if datetime.datetime.utcnow() >= client["expires"]:
2664
if not client["last_checked_ok"]:
2665
logger.warning(
2666
"disabling client {} - Client never "
2667
"performed a successful checker".format(
2668
client_name))
2669
client["enabled"] = False
2670
elif client["last_checker_status"] != 0:
2671
logger.warning(
2672
"disabling client {} - Client last"
2673
" checker failed with error code"
2674
" {}".format(
2675
client_name,
2676
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:
2677
2250
client["enabled"] = False
2678
2251
else:
2679
client["expires"] = (
2680
datetime.datetime.utcnow()
2681
+ client["timeout"])
2682
logger.debug("Last checker succeeded,"
2683
" keeping {} enabled".format(
2684
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
2685
2284
try:
2686
client["secret"] = pgp.decrypt(
2687
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 = (
2688
2293
client_settings[client_name]["secret"])
2689
except PGPError:
2690
# If decryption fails, we use secret from new settings
2691
logger.debug("Failed to decrypt {} old secret".format(
2692
client_name))
2693
client["secret"] = (client_settings[client_name]
2694
["secret"])
2695
2696
# Add/remove clients based on new changes made to config
2697
for client_name in (set(old_client_settings)
2698
- set(client_settings)):
2699
del clients_data[client_name]
2700
for client_name in (set(client_settings)
2701
- set(old_client_settings)):
2702
clients_data[client_name] = client_settings[client_name]
2703
2704
# Create all client objects
2705
for client_name, client in clients_data.items():
2706
tcp_server.clients[client_name] = client_class(
2707
name = client_name,
2708
settings = client,
2709
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]))
2710
2304
2711
2305
if not tcp_server.clients:
2712
2306
logger.warning("No clients defined")
2713
2714
if not foreground:
2715
if pidfile is not None:
2716
pid = os.getpid()
2717
try:
2718
with pidfile:
2719
print(pid, file=pidfile)
2720
except IOError:
2721
logger.error("Could not write to file %r with PID %d",
2722
pidfilename, pid)
2723
del pidfile
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
2724
2320
del pidfilename
2321
2322
signal.signal(signal.SIGINT, signal.SIG_IGN)
2725
2323
2726
2324
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2727
2325
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2728
2326
2729
2327
if use_dbus:
2730
2731
@alternate_dbus_interfaces(
2732
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2733
class MandosDBusService(DBusObjectWithProperties):
2328
class MandosDBusService(dbus.service.Object):
2734
2329
"""A D-Bus proxy object"""
2735
2736
2330
def __init__(self):
2737
2331
dbus.service.Object.__init__(self, bus, "/")
2738
2739
2332
_interface = "se.recompile.Mandos"
2740
2333
2741
@dbus_interface_annotations(_interface)
2742
def _foo(self):
2743
return {
2744
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2745
"false" }
2746
2747
2334
@dbus.service.signal(_interface, signature="o")
2748
2335
def ClientAdded(self, objpath):
2749
2336
"D-Bus signal"
2762
2349
@dbus.service.method(_interface, out_signature="ao")
2763
2350
def GetAllClients(self):
2764
2351
"D-Bus method"
2765
return dbus.Array(c.dbus_object_path for c in
2352
return dbus.Array(c.dbus_object_path
2353
for c in
2766
2354
tcp_server.clients.itervalues())
2767
2355
2768
2356
@dbus.service.method(_interface,
2770
2358
def GetAllClientsWithProperties(self):
2771
2359
"D-Bus method"
2772
2360
return dbus.Dictionary(
2773
{ c.dbus_object_path: c.GetAll("")
2774
for c in tcp_server.clients.itervalues() },
2361
((c.dbus_object_path, c.GetAll(""))
2362
for c in tcp_server.clients.itervalues()),
2775
2363
signature="oa{sv}")
2776
2364
2777
2365
@dbus.service.method(_interface, in_signature="o")
2790
2378
2791
2379
del _interface
2792
2380
2793
mandos_dbus_service = MandosDBusService()
2381
class MandosDBusServiceTransitional(MandosDBusService):
2382
__metaclass__ = AlternateDBusNamesMetaclass
2383
mandos_dbus_service = MandosDBusServiceTransitional()
2794
2384
2795
2385
def cleanup():
2796
2386
"Cleanup function; run on exit"
2797
if zeroconf:
2798
service.cleanup()
2387
service.cleanup()
2799
2388
2800
2389
multiprocessing.active_children()
2801
wnull.close()
2802
2390
if not (tcp_server.clients or client_settings):
2803
2391
return
2804
2392
2805
2393
# Store client before exiting. Secrets are encrypted with key
2806
2394
# based on what config file has. If config file is
2807
2395
# removed/edited, old secret will thus be unrecovable.
2808
clients = {}
2809
with PGPEngine() as pgp:
2396
clients = []
2397
with Crypto() as crypt:
2810
2398
for client in tcp_server.clients.itervalues():
2811
2399
key = client_settings[client.name]["secret"]
2812
client.encrypted_secret = pgp.encrypt(client.secret,
2813
key)
2400
client.encrypted_secret = crypt.encrypt(client.secret,
2401
key)
2814
2402
client_dict = {}
2815
2403
2816
# A list of attributes that can not be pickled
2817
# + secret.
2818
exclude = { "bus", "changedstate", "secret",
2819
"checker", "server_settings" }
2820
for name, typ in inspect.getmembers(dbus.service
2821
.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)):
2822
2409
exclude.add(name)
2823
2410
2824
2411
client_dict["encrypted_secret"] = (client
2827
2414
if attr not in exclude:
2828
2415
client_dict[attr] = getattr(client, attr)
2829
2416
2830
clients[client.name] = client_dict
2417
clients.append(client_dict)
2831
2418
del client_settings[client.name]["secret"]
2832
2419
2833
2420
try:
2834
with tempfile.NamedTemporaryFile(
2835
mode='wb',
2836
suffix=".pickle",
2837
prefix='clients-',
2838
dir=os.path.dirname(stored_state_path),
2839
delete=False) as stored_state:
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:
2840
2424
pickle.dump((clients, client_settings), stored_state)
2841
tempname = stored_state.name
2842
os.rename(tempname, stored_state_path)
2843
2425
except (IOError, OSError) as e:
2844
if not debug:
2845
try:
2846
os.remove(tempname)
2847
except NameError:
2848
pass
2849
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2850
logger.warning("Could not save persistent state: {}"
2851
.format(os.strerror(e.errno)))
2852
else:
2853
logger.warning("Could not save persistent state:",
2854
exc_info=e)
2426
logger.warning("Could not save persistent state: {0}"
2427
.format(e))
2428
if e.errno not in (errno.ENOENT, errno.EACCES):
2855
2429
raise
2856
2430
2857
2431
# Delete all clients, and settings from config
2863
2437
client.disable(quiet=True)
2864
2438
if use_dbus:
2865
2439
# Emit D-Bus signal
2866
mandos_dbus_service.ClientRemoved(
2867
client.dbus_object_path, client.name)
2440
mandos_dbus_service.ClientRemoved(client
2441
.dbus_object_path,
2442
client.name)
2868
2443
client_settings.clear()
2869
2444
2870
2445
atexit.register(cleanup)
2881
2456
tcp_server.server_activate()
2882
2457
2883
2458
# Find out what port we got
2884
if zeroconf:
2885
service.port = tcp_server.socket.getsockname()[1]
2459
service.port = tcp_server.socket.getsockname()[1]
2886
2460
if use_ipv6:
2887
2461
logger.info("Now listening on address %r, port %d,"
2888
" flowinfo %d, scope_id %d",
2889
*tcp_server.socket.getsockname())
2462
" flowinfo %d, scope_id %d"
2463
% tcp_server.socket.getsockname())
2890
2464
else: # IPv4
2891
logger.info("Now listening on address %r, port %d",
2892
*tcp_server.socket.getsockname())
2465
logger.info("Now listening on address %r, port %d"
2466
% tcp_server.socket.getsockname())
2893
2467
2894
2468
#service.interface = tcp_server.socket.getsockname()[3]
2895
2469
2896
2470
try:
2897
if zeroconf:
2898
# From the Avahi example code
2899
try:
2900
service.activate()
2901
except dbus.exceptions.DBusException as error:
2902
logger.critical("D-Bus Exception", exc_info=error)
2903
cleanup()
2904
sys.exit(1)
2905
# End of Avahi example code
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
2906
2479
2907
2480
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2908
2481
lambda *args, **kwargs:
2912
2485
logger.debug("Starting main loop")
2913
2486
main_loop.run()
2914
2487
except AvahiError as error:
2915
logger.critical("Avahi Error", exc_info=error)
2488
logger.critical("AvahiError: %s", error)
2916
2489
cleanup()
2917
2490
sys.exit(1)
2918
2491
except KeyboardInterrupt:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0