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