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