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