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