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