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