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