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