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