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