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