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