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