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 535
- compare with another revision
- download diff
- download tarball
- view history from revision 535
- Committer: teddy at bsnet
- Date: 2011-12-25 00:43:51 UTC
- Revision ID: teddy@fukt.bsnet.se-20111225004351-3hw3msbs8ooesltd
Removed implemented TODO entry
- 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:
395
350
logger.error(bad_states[state] + ": %r", error)
396
351
self.cleanup()
397
352
elif state == avahi.SERVER_RUNNING:
398
try:
399
self.add()
400
except dbus.exceptions.DBusException as error:
401
if (error.get_dbus_name()
402
== "org.freedesktop.Avahi.CollisionError"):
403
logger.info("Local Zeroconf service name"
404
" collision.")
405
return self.rename(remove=False)
406
else:
407
logger.critical("D-Bus Exception", exc_info=error)
408
self.cleanup()
409
os._exit(1)
353
self.add()
410
354
else:
411
355
if error is None:
412
356
logger.debug("Unknown state: %r", state)
413
357
else:
414
358
logger.debug("Unknown state: %r: %r", state, error)
415
416
359
def activate(self):
417
360
"""Derived from the Avahi example code"""
418
361
if self.server is None:
422
365
follow_name_owner_changes=True),
423
366
avahi.DBUS_INTERFACE_SERVER)
424
367
self.server.connect_to_signal("StateChanged",
425
self.server_state_changed)
368
self.server_state_changed)
426
369
self.server_state_changed(self.server.GetState())
427
370
428
429
371
class AvahiServiceToSyslog(AvahiService):
430
def rename(self, *args, **kwargs):
372
def rename(self):
431
373
"""Add the new name to the syslog messages"""
432
ret = AvahiService.rename(self, *args, **kwargs)
433
syslogger.setFormatter(logging.Formatter(
434
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
435
.format(self.name)))
374
ret = AvahiService.rename(self)
375
syslogger.setFormatter(logging.Formatter
376
('Mandos (%s) [%%(process)d]:'
377
' %%(levelname)s: %%(message)s'
378
% self.name))
436
379
return ret
437
380
438
def call_pipe(connection, # : multiprocessing.Connection
439
func, *args, **kwargs):
440
"""This function is meant to be called by multiprocessing.Process
441
442
This function runs func(*args, **kwargs), and writes the resulting
443
return value on the provided multiprocessing.Connection.
444
"""
445
connection.send(func(*args, **kwargs))
446
connection.close()
447
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
448
387
class Client(object):
449
388
"""A representation of a client host served by this server.
450
389
475
414
last_checked_ok: datetime.datetime(); (UTC) or None
476
415
last_checker_status: integer between 0 and 255 reflecting exit
477
416
status of last checker. -1 reflects crashed
478
checker, -2 means no checker completed yet.
479
last_checker_signal: The signal which killed the last checker, if
480
last_checker_status is -1
417
checker, or None.
481
418
last_enabled: datetime.datetime(); (UTC) or None
482
419
name: string; from the config file, used in log messages and
483
420
D-Bus identifiers
484
421
secret: bytestring; sent verbatim (over TLS) to client
485
422
timeout: datetime.timedelta(); How long from last_checked_ok
486
423
until this client is disabled
487
extended_timeout: extra long timeout when secret has been sent
424
extended_timeout: extra long timeout when password has been sent
488
425
runtime_expansions: Allowed attributes for runtime expansion.
489
426
expires: datetime.datetime(); time (UTC) when a client will be
490
427
disabled, or None
491
server_settings: The server_settings dict from main()
492
428
"""
493
429
494
430
runtime_expansions = ("approval_delay", "approval_duration",
495
"created", "enabled", "expires",
496
"fingerprint", "host", "interval",
497
"last_approval_request", "last_checked_ok",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
498
433
"last_enabled", "name", "timeout")
499
client_defaults = {
500
"timeout": "PT5M",
501
"extended_timeout": "PT15M",
502
"interval": "PT2M",
503
"checker": "fping -q -- %%(host)s",
504
"host": "",
505
"approval_delay": "PT0S",
506
"approval_duration": "PT1S",
507
"approved_by_default": "True",
508
"enabled": "True",
509
}
510
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
511
460
@staticmethod
512
461
def config_parser(config):
513
"""Construct a new dict of client settings of this form:
462
""" Construct a new dict of client settings of this form:
514
463
{ client_name: {setting_name: value, ...}, ...}
515
with exceptions for any special settings as defined above.
516
NOTE: Must be a pure function. Must return the same result
517
value given the same arguments.
518
"""
464
with exceptions for any special settings as defined above"""
519
465
settings = {}
520
466
for client_name in config.sections():
521
467
section = dict(config.items(client_name))
525
471
# Reformat values from string types to Python types
526
472
client["approved_by_default"] = config.getboolean(
527
473
client_name, "approved_by_default")
528
client["enabled"] = config.getboolean(client_name,
529
"enabled")
474
client["enabled"] = config.getboolean(client_name, "enabled")
530
475
531
# Uppercase and remove spaces from fingerprint for later
532
# comparison purposes with return value from the
533
# fingerprint() function
534
476
client["fingerprint"] = (section["fingerprint"].upper()
535
477
.replace(" ", ""))
536
478
if "secret" in section:
541
483
"rb") as secfile:
542
484
client["secret"] = secfile.read()
543
485
else:
544
raise TypeError("No secret or secfile for section {}"
545
.format(section))
486
raise TypeError("No secret or secfile for section %s"
487
% section)
546
488
client["timeout"] = string_to_delta(section["timeout"])
547
489
client["extended_timeout"] = string_to_delta(
548
490
section["extended_timeout"])
554
496
client["checker_command"] = section["checker"]
555
497
client["last_approval_request"] = None
556
498
client["last_checked_ok"] = None
557
client["last_checker_status"] = -2
558
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
559
508
return settings
560
561
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."""
562
515
self.name = name
563
if server_settings is None:
564
server_settings = {}
565
self.server_settings = server_settings
566
516
# adding all client settings
567
for setting, value in settings.items():
517
for setting, value in settings.iteritems():
568
518
setattr(self, setting, value)
569
519
570
if self.enabled:
571
if not hasattr(self, "last_enabled"):
572
self.last_enabled = datetime.datetime.utcnow()
573
if not hasattr(self, "expires"):
574
self.expires = (datetime.datetime.utcnow()
575
+ self.timeout)
576
else:
577
self.last_enabled = None
578
self.expires = None
579
580
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
581
524
logger.debug(" Fingerprint: %s", self.fingerprint)
582
self.created = settings.get("created",
583
datetime.datetime.utcnow())
584
525
self.created = settings.get("created", datetime.datetime.utcnow())
526
585
527
# attributes specific for this server instance
586
528
self.checker = None
587
529
self.checker_initiator_tag = None
590
532
self.current_checker_command = None
591
533
self.approved = None
592
534
self.approvals_pending = 0
593
self.changedstate = multiprocessing_manager.Condition(
594
multiprocessing_manager.Lock())
595
self.client_structure = [attr
596
for attr in self.__dict__.iterkeys()
535
self.changedstate = (multiprocessing_manager
536
.Condition(multiprocessing_manager
537
.Lock()))
538
self.client_structure = [attr for attr in
539
self.__dict__.iterkeys()
597
540
if not attr.startswith("_")]
598
541
self.client_structure.append("client_structure")
599
542
600
for name, t in inspect.getmembers(
601
type(self), lambda obj: isinstance(obj, property)):
543
for name, t in inspect.getmembers(type(self),
544
lambda obj:
545
isinstance(obj,
546
property)):
602
547
if not name.startswith("_"):
603
548
self.client_structure.append(name)
604
549
612
557
if getattr(self, "enabled", False):
613
558
# Already enabled
614
559
return
560
self.send_changedstate()
615
561
self.expires = datetime.datetime.utcnow() + self.timeout
616
562
self.enabled = True
617
563
self.last_enabled = datetime.datetime.utcnow()
618
564
self.init_checker()
619
self.send_changedstate()
620
565
621
566
def disable(self, quiet=True):
622
567
"""Disable this client."""
623
568
if not getattr(self, "enabled", False):
624
569
return False
625
570
if not quiet:
571
self.send_changedstate()
572
if not quiet:
626
573
logger.info("Disabling client %s", self.name)
627
if getattr(self, "disable_initiator_tag", None) is not None:
574
if getattr(self, "disable_initiator_tag", False):
628
575
gobject.source_remove(self.disable_initiator_tag)
629
576
self.disable_initiator_tag = None
630
577
self.expires = None
631
if getattr(self, "checker_initiator_tag", None) is not None:
578
if getattr(self, "checker_initiator_tag", False):
632
579
gobject.source_remove(self.checker_initiator_tag)
633
580
self.checker_initiator_tag = None
634
581
self.stop_checker()
635
582
self.enabled = False
636
if not quiet:
637
self.send_changedstate()
638
583
# Do not run this again if called by a gobject.timeout_add
639
584
return False
640
585
644
589
def init_checker(self):
645
590
# Schedule a new checker to be started an 'interval' from now,
646
591
# and every interval from then on.
647
if self.checker_initiator_tag is not None:
648
gobject.source_remove(self.checker_initiator_tag)
649
self.checker_initiator_tag = gobject.timeout_add(
650
int(self.interval.total_seconds() * 1000),
651
self.start_checker)
592
self.checker_initiator_tag = (gobject.timeout_add
593
(self.interval_milliseconds(),
594
self.start_checker))
652
595
# Schedule a disable() when 'timeout' has passed
653
if self.disable_initiator_tag is not None:
654
gobject.source_remove(self.disable_initiator_tag)
655
self.disable_initiator_tag = gobject.timeout_add(
656
int(self.timeout.total_seconds() * 1000), self.disable)
596
self.disable_initiator_tag = (gobject.timeout_add
597
(self.timeout_milliseconds(),
598
self.disable))
657
599
# Also start a new checker *right now*.
658
600
self.start_checker()
659
601
660
def checker_callback(self, source, condition, connection,
661
command):
602
def checker_callback(self, pid, condition, command):
662
603
"""The checker has completed, so take appropriate actions."""
663
604
self.checker_callback_tag = None
664
605
self.checker = None
665
# Read return code from connection (see call_pipe)
666
returncode = connection.recv()
667
connection.close()
668
669
if returncode >= 0:
670
self.last_checker_status = returncode
671
self.last_checker_signal = None
606
if os.WIFEXITED(condition):
607
self.last_checker_status = os.WEXITSTATUS(condition)
672
608
if self.last_checker_status == 0:
673
609
logger.info("Checker for %(name)s succeeded",
674
610
vars(self))
675
611
self.checked_ok()
676
612
else:
677
logger.info("Checker for %(name)s failed", vars(self))
613
logger.info("Checker for %(name)s failed",
614
vars(self))
678
615
else:
679
616
self.last_checker_status = -1
680
self.last_checker_signal = -returncode
681
617
logger.warning("Checker for %(name)s crashed?",
682
618
vars(self))
683
return False
684
685
def checked_ok(self):
686
"""Assert that the client has been seen, alive and well."""
687
self.last_checked_ok = datetime.datetime.utcnow()
688
self.last_checker_status = 0
689
self.last_checker_signal = None
690
self.bump_timeout()
691
692
def bump_timeout(self, timeout=None):
693
"""Bump up the timeout for this client."""
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
"""
694
626
if timeout is None:
695
627
timeout = self.timeout
628
self.last_checked_ok = datetime.datetime.utcnow()
696
629
if self.disable_initiator_tag is not None:
697
630
gobject.source_remove(self.disable_initiator_tag)
698
self.disable_initiator_tag = None
699
631
if getattr(self, "enabled", False):
700
self.disable_initiator_tag = gobject.timeout_add(
701
int(timeout.total_seconds() * 1000), self.disable)
632
self.disable_initiator_tag = (gobject.timeout_add
633
(timedelta_to_milliseconds
634
(timeout), self.disable))
702
635
self.expires = datetime.datetime.utcnow() + timeout
703
636
704
637
def need_approval(self):
710
643
If a checker already exists, leave it running and do
711
644
nothing."""
712
645
# The reason for not killing a running checker is that if we
713
# did that, and if a checker (for some reason) started running
714
# slowly and taking more than 'interval' time, then the client
715
# would inevitably timeout, since no checker would get a
716
# chance to run to completion. If we instead leave running
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
717
650
# checkers alone, the checker would have to take more time
718
651
# than 'timeout' for the client to be disabled, which is as it
719
652
# should be.
720
653
721
if self.checker is not None and not self.checker.is_alive():
722
logger.warning("Checker was not alive; joining")
723
self.checker.join()
724
self.checker = None
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)
725
667
# Start a new checker if needed
726
668
if self.checker is None:
727
# Escape attributes for the shell
728
escaped_attrs = {
729
attr: re.escape(str(getattr(self, attr)))
730
for attr in self.runtime_expansions }
731
669
try:
732
command = self.checker_command % escaped_attrs
733
except TypeError as error:
734
logger.error('Could not format string "%s"',
735
self.checker_command,
736
exc_info=error)
737
return True # Try again later
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
738
688
self.current_checker_command = command
739
logger.info("Starting checker %r for %s", command,
740
self.name)
741
# We don't need to redirect stdout and stderr, since
742
# in normal mode, that is already done by daemon(),
743
# and in debug mode we don't want to. (Stdin is
744
# always replaced by /dev/null.)
745
# The exception is when not debugging but nevertheless
746
# running in the foreground; use the previously
747
# created wnull.
748
popen_args = { "close_fds": True,
749
"shell": True,
750
"cwd": "/" }
751
if (not self.server_settings["debug"]
752
and self.server_settings["foreground"]):
753
popen_args.update({"stdout": wnull,
754
"stderr": wnull })
755
pipe = multiprocessing.Pipe(duplex = False)
756
self.checker = multiprocessing.Process(
757
target = call_pipe,
758
args = (pipe[1], subprocess.call, command),
759
kwargs = popen_args)
760
self.checker.start()
761
self.checker_callback_tag = gobject.io_add_watch(
762
pipe[0].fileno(), gobject.IO_IN,
763
self.checker_callback, pipe[0], command)
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)
764
712
# Re-run this periodically if run by gobject.timeout_add
765
713
return True
766
714
772
720
if getattr(self, "checker", None) is None:
773
721
return
774
722
logger.debug("Stopping checker for %(name)s", vars(self))
775
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
776
731
self.checker = None
777
732
778
733
779
def dbus_service_property(dbus_interface,
780
signature="v",
781
access="readwrite",
782
byte_arrays=False):
734
def dbus_service_property(dbus_interface, signature="v",
735
access="readwrite", byte_arrays=False):
783
736
"""Decorators for marking methods of a DBusObjectWithProperties to
784
737
become properties on the D-Bus.
785
738
794
747
# "Set" method, so we fail early here:
795
748
if byte_arrays and signature != "ay":
796
749
raise ValueError("Byte arrays not supported for non-'ay'"
797
" signature {!r}".format(signature))
798
750
" signature %r" % signature)
799
751
def decorator(func):
800
752
func._dbus_is_property = True
801
753
func._dbus_interface = dbus_interface
806
758
func._dbus_name = func._dbus_name[:-14]
807
759
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
808
760
return func
809
810
return decorator
811
812
813
def dbus_interface_annotations(dbus_interface):
814
"""Decorator for marking functions returning interface annotations
815
816
Usage:
817
818
@dbus_interface_annotations("org.example.Interface")
819
def _foo(self): # Function name does not matter
820
return {"org.freedesktop.DBus.Deprecated": "true",
821
"org.freedesktop.DBus.Property.EmitsChangedSignal":
822
"false"}
823
"""
824
825
def decorator(func):
826
func._dbus_is_interface = True
827
func._dbus_interface = dbus_interface
828
func._dbus_name = dbus_interface
829
return func
830
831
return decorator
832
833
834
def dbus_annotations(annotations):
835
"""Decorator to annotate D-Bus methods, signals or properties
836
Usage:
837
838
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
839
"org.freedesktop.DBus.Property."
840
"EmitsChangedSignal": "false"})
841
@dbus_service_property("org.example.Interface", signature="b",
842
access="r")
843
def Property_dbus_property(self):
844
return dbus.Boolean(False)
845
"""
846
847
def decorator(func):
848
func._dbus_annotations = annotations
849
return func
850
851
761
return decorator
852
762
853
763
854
764
class DBusPropertyException(dbus.exceptions.DBusException):
855
765
"""A base class for D-Bus property-related exceptions
856
766
"""
857
pass
767
def __unicode__(self):
768
return unicode(str(self))
858
769
859
770
860
771
class DBusPropertyAccessException(DBusPropertyException):
878
789
"""
879
790
880
791
@staticmethod
881
def _is_dbus_thing(thing):
882
"""Returns a function testing if an attribute is a D-Bus thing
883
884
If called like _is_dbus_thing("method") it returns a function
885
suitable for use as predicate to inspect.getmembers().
886
"""
887
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
888
False)
792
def _is_dbus_property(obj):
793
return getattr(obj, "_dbus_is_property", False)
889
794
890
def _get_all_dbus_things(self, thing):
795
def _get_all_dbus_properties(self):
891
796
"""Returns a generator of (name, attribute) pairs
892
797
"""
893
return ((getattr(athing.__get__(self), "_dbus_name", name),
894
athing.__get__(self))
798
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
895
799
for cls in self.__class__.__mro__
896
for name, athing in
897
inspect.getmembers(cls, self._is_dbus_thing(thing)))
800
for name, prop in
801
inspect.getmembers(cls, self._is_dbus_property))
898
802
899
803
def _get_dbus_property(self, interface_name, property_name):
900
804
"""Returns a bound method if one exists which is a D-Bus
901
805
property with the specified name and interface.
902
806
"""
903
for cls in self.__class__.__mro__:
904
for name, value in inspect.getmembers(
905
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)):
906
810
if (value._dbus_name == property_name
907
811
and value._dbus_interface == interface_name):
908
812
return value.__get__(self)
909
813
910
814
# No such property
911
raise DBusPropertyNotFound("{}:{}.{}".format(
912
self.dbus_object_path, interface_name, property_name))
815
raise DBusPropertyNotFound(self.dbus_object_path + ":"
816
+ interface_name + "."
817
+ property_name)
913
818
914
@dbus.service.method(dbus.PROPERTIES_IFACE,
915
in_signature="ss",
819
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
916
820
out_signature="v")
917
821
def Get(self, interface_name, property_name):
918
822
"""Standard D-Bus property Get() method, see D-Bus standard.
936
840
# The byte_arrays option is not supported yet on
937
841
# signatures other than "ay".
938
842
if prop._dbus_signature != "ay":
939
raise ValueError("Byte arrays not supported for non-"
940
"'ay' signature {!r}"
941
.format(prop._dbus_signature))
942
value = dbus.ByteArray(b''.join(chr(byte)
943
for byte in value))
843
raise ValueError
844
value = dbus.ByteArray(''.join(unichr(byte)
845
for byte in value))
944
846
prop(value)
945
847
946
@dbus.service.method(dbus.PROPERTIES_IFACE,
947
in_signature="s",
848
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
948
849
out_signature="a{sv}")
949
850
def GetAll(self, interface_name):
950
851
"""Standard D-Bus property GetAll() method, see D-Bus
953
854
Note: Will not include properties with access="write".
954
855
"""
955
856
properties = {}
956
for name, prop in self._get_all_dbus_things("property"):
857
for name, prop in self._get_all_dbus_properties():
957
858
if (interface_name
958
859
and interface_name != prop._dbus_interface):
959
860
# Interface non-empty but did not match
965
866
if not hasattr(value, "variant_level"):
966
867
properties[name] = value
967
868
continue
968
properties[name] = type(value)(
969
value, variant_level = value.variant_level + 1)
869
properties[name] = type(value)(value, variant_level=
870
value.variant_level+1)
970
871
return dbus.Dictionary(properties, signature="sv")
971
872
972
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
973
def PropertiesChanged(self, interface_name, changed_properties,
974
invalidated_properties):
975
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
976
standard.
977
"""
978
pass
979
980
873
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
981
874
out_signature="s",
982
875
path_keyword='object_path',
983
876
connection_keyword='connection')
984
877
def Introspect(self, object_path, connection):
985
"""Overloading of standard D-Bus method.
986
987
Inserts property tags and interface annotation tags.
878
"""Standard D-Bus method, overloaded to insert property tags.
988
879
"""
989
880
xmlstring = dbus.service.Object.Introspect(self, object_path,
990
881
connection)
991
882
try:
992
883
document = xml.dom.minidom.parseString(xmlstring)
993
994
884
def make_tag(document, name, prop):
995
885
e = document.createElement("property")
996
886
e.setAttribute("name", name)
997
887
e.setAttribute("type", prop._dbus_signature)
998
888
e.setAttribute("access", prop._dbus_access)
999
889
return e
1000
1001
890
for if_tag in document.getElementsByTagName("interface"):
1002
# Add property tags
1003
891
for tag in (make_tag(document, name, prop)
1004
892
for name, prop
1005
in self._get_all_dbus_things("property")
893
in self._get_all_dbus_properties()
1006
894
if prop._dbus_interface
1007
895
== if_tag.getAttribute("name")):
1008
896
if_tag.appendChild(tag)
1009
# Add annotation tags
1010
for typ in ("method", "signal", "property"):
1011
for tag in if_tag.getElementsByTagName(typ):
1012
annots = dict()
1013
for name, prop in (self.
1014
_get_all_dbus_things(typ)):
1015
if (name == tag.getAttribute("name")
1016
and prop._dbus_interface
1017
== if_tag.getAttribute("name")):
1018
annots.update(getattr(
1019
prop, "_dbus_annotations", {}))
1020
for name, value in annots.items():
1021
ann_tag = document.createElement(
1022
"annotation")
1023
ann_tag.setAttribute("name", name)
1024
ann_tag.setAttribute("value", value)
1025
tag.appendChild(ann_tag)
1026
# Add interface annotation tags
1027
for annotation, value in dict(
1028
itertools.chain.from_iterable(
1029
annotations().items()
1030
for name, annotations
1031
in self._get_all_dbus_things("interface")
1032
if name == if_tag.getAttribute("name")
1033
)).items():
1034
ann_tag = document.createElement("annotation")
1035
ann_tag.setAttribute("name", annotation)
1036
ann_tag.setAttribute("value", value)
1037
if_tag.appendChild(ann_tag)
1038
897
# Add the names to the return values for the
1039
898
# "org.freedesktop.DBus.Properties" methods
1040
899
if (if_tag.getAttribute("name")
1055
914
except (AttributeError, xml.dom.DOMException,
1056
915
xml.parsers.expat.ExpatError) as error:
1057
916
logger.error("Failed to override Introspection method",
1058
exc_info=error)
917
error)
1059
918
return xmlstring
1060
919
1061
920
1062
def datetime_to_dbus(dt, variant_level=0):
921
def datetime_to_dbus (dt, variant_level=0):
1063
922
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1064
923
if dt is None:
1065
924
return dbus.String("", variant_level = variant_level)
1066
return dbus.String(dt.isoformat(), variant_level=variant_level)
1067
1068
1069
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1070
"""A class decorator; applied to a subclass of
1071
dbus.service.Object, it will add alternate D-Bus attributes with
1072
interface names according to the "alt_interface_names" mapping.
1073
Usage:
1074
1075
@alternate_dbus_interfaces({"org.example.Interface":
1076
"net.example.AlternateInterface"})
1077
class SampleDBusObject(dbus.service.Object):
1078
@dbus.service.method("org.example.Interface")
1079
def SampleDBusMethod():
1080
pass
1081
1082
The above "SampleDBusMethod" on "SampleDBusObject" will be
1083
reachable via two interfaces: "org.example.Interface" and
1084
"net.example.AlternateInterface", the latter of which will have
1085
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1086
"true", unless "deprecate" is passed with a False value.
1087
1088
This works for methods and signals, and also for D-Bus properties
1089
(from DBusObjectWithProperties) and interfaces (from the
1090
dbus_interface_annotations decorator).
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.
1091
933
"""
1092
1093
def wrapper(cls):
1094
for orig_interface_name, alt_interface_name in (
1095
alt_interface_names.items()):
1096
attr = {}
1097
interface_names = set()
1098
# Go though all attributes of the class
1099
for attrname, attribute in inspect.getmembers(cls):
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):
1100
941
# Ignore non-D-Bus attributes, and D-Bus attributes
1101
942
# with the wrong interface name
1102
943
if (not hasattr(attribute, "_dbus_interface")
1103
or not attribute._dbus_interface.startswith(
1104
orig_interface_name)):
944
or not attribute._dbus_interface
945
.startswith("se.recompile.Mandos")):
1105
946
continue
1106
947
# Create an alternate D-Bus interface name based on
1107
948
# the current name
1108
alt_interface = attribute._dbus_interface.replace(
1109
orig_interface_name, alt_interface_name)
1110
interface_names.add(alt_interface)
949
alt_interface = (attribute._dbus_interface
950
.replace("se.recompile.Mandos",
951
"se.bsnet.fukt.Mandos"))
1111
952
# Is this a D-Bus signal?
1112
953
if getattr(attribute, "_dbus_is_signal", False):
1113
if sys.version_info.major == 2:
1114
# Extract the original non-method undecorated
1115
# function by black magic
1116
nonmethod_func = (dict(
954
# Extract the original non-method function by
955
# black magic
956
nonmethod_func = (dict(
1117
957
zip(attribute.func_code.co_freevars,
1118
attribute.__closure__))
1119
["func"].cell_contents)
1120
else:
1121
nonmethod_func = attribute
958
attribute.__closure__))["func"]
959
.cell_contents)
1122
960
# Create a new, but exactly alike, function
1123
961
# object, and decorate it to be a new D-Bus signal
1124
962
# with the alternate D-Bus interface name
1125
if sys.version_info.major == 2:
1126
new_function = types.FunctionType(
1127
nonmethod_func.func_code,
1128
nonmethod_func.func_globals,
1129
nonmethod_func.func_name,
1130
nonmethod_func.func_defaults,
1131
nonmethod_func.func_closure)
1132
else:
1133
new_function = types.FunctionType(
1134
nonmethod_func.__code__,
1135
nonmethod_func.__globals__,
1136
nonmethod_func.__name__,
1137
nonmethod_func.__defaults__,
1138
nonmethod_func.__closure__)
1139
new_function = (dbus.service.signal(
1140
alt_interface,
1141
attribute._dbus_signature)(new_function))
1142
# Copy annotations, if any
1143
try:
1144
new_function._dbus_annotations = dict(
1145
attribute._dbus_annotations)
1146
except AttributeError:
1147
pass
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)))
1148
972
# Define a creator of a function to call both the
1149
# original and alternate functions, so both the
1150
# original and alternate signals gets sent when
1151
# the function is called
973
# old and new functions, so both the old and new
974
# signals gets sent when the function is called
1152
975
def fixscope(func1, func2):
1153
976
"""This function is a scope container to pass
1154
977
func1 and func2 to the "call_both" function
1155
978
outside of its arguments"""
1156
1157
979
def call_both(*args, **kwargs):
1158
980
"""This function will emit two D-Bus
1159
981
signals by calling func1 and func2"""
1160
982
func1(*args, **kwargs)
1161
983
func2(*args, **kwargs)
1162
1163
984
return call_both
1164
985
# Create the "call_both" function and add it to
1165
986
# the class
1166
attr[attrname] = fixscope(attribute, new_function)
987
attr[attrname] = fixscope(attribute,
988
new_function)
1167
989
# Is this a D-Bus method?
1168
990
elif getattr(attribute, "_dbus_is_method", False):
1169
991
# Create a new, but exactly alike, function
1170
992
# object. Decorate it to be a new D-Bus method
1171
993
# with the alternate D-Bus interface name. Add it
1172
994
# to the class.
1173
attr[attrname] = (
1174
dbus.service.method(
1175
alt_interface,
1176
attribute._dbus_in_signature,
1177
attribute._dbus_out_signature)
1178
(types.FunctionType(attribute.func_code,
1179
attribute.func_globals,
1180
attribute.func_name,
1181
attribute.func_defaults,
1182
attribute.func_closure)))
1183
# Copy annotations, if any
1184
try:
1185
attr[attrname]._dbus_annotations = dict(
1186
attribute._dbus_annotations)
1187
except AttributeError:
1188
pass
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)))
1189
1005
# Is this a D-Bus property?
1190
1006
elif getattr(attribute, "_dbus_is_property", False):
1191
1007
# Create a new, but exactly alike, function
1192
1008
# object, and decorate it to be a new D-Bus
1193
1009
# property with the alternate D-Bus interface
1194
1010
# name. Add it to the class.
1195
attr[attrname] = (dbus_service_property(
1196
alt_interface, attribute._dbus_signature,
1197
attribute._dbus_access,
1198
attribute._dbus_get_args_options
1199
["byte_arrays"])
1200
(types.FunctionType(
1201
attribute.func_code,
1202
attribute.func_globals,
1203
attribute.func_name,
1204
attribute.func_defaults,
1205
attribute.func_closure)))
1206
# Copy annotations, if any
1207
try:
1208
attr[attrname]._dbus_annotations = dict(
1209
attribute._dbus_annotations)
1210
except AttributeError:
1211
pass
1212
# Is this a D-Bus interface?
1213
elif getattr(attribute, "_dbus_is_interface", False):
1214
# Create a new, but exactly alike, function
1215
# object. Decorate it to be a new D-Bus interface
1216
# with the alternate D-Bus interface name. Add it
1217
# to the class.
1218
attr[attrname] = (
1219
dbus_interface_annotations(alt_interface)
1220
(types.FunctionType(attribute.func_code,
1221
attribute.func_globals,
1222
attribute.func_name,
1223
attribute.func_defaults,
1224
attribute.func_closure)))
1225
if deprecate:
1226
# Deprecate all alternate interfaces
1227
iname="_AlternateDBusNames_interface_annotation{}"
1228
for interface_name in interface_names:
1229
1230
@dbus_interface_annotations(interface_name)
1231
def func(self):
1232
return { "org.freedesktop.DBus.Deprecated":
1233
"true" }
1234
# Find an unused name
1235
for aname in (iname.format(i)
1236
for i in itertools.count()):
1237
if aname not in attr:
1238
attr[aname] = func
1239
break
1240
if interface_names:
1241
# Replace the class with a new subclass of it with
1242
# methods, signals, etc. as created above.
1243
cls = type(b"{}Alternate".format(cls.__name__),
1244
(cls, ), attr)
1245
return cls
1246
1247
return wrapper
1248
1249
1250
@alternate_dbus_interfaces({"se.recompile.Mandos":
1251
"se.bsnet.fukt.Mandos"})
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
1252
1027
class ClientDBus(Client, DBusObjectWithProperties):
1253
1028
"""A Client class using D-Bus
1254
1029
1258
1033
"""
1259
1034
1260
1035
runtime_expansions = (Client.runtime_expansions
1261
+ ("dbus_object_path", ))
1262
1263
_interface = "se.recompile.Mandos.Client"
1036
+ ("dbus_object_path",))
1264
1037
1265
1038
# dbus.service.Object doesn't use super(), so we can't either.
1266
1039
1267
1040
def __init__(self, bus = None, *args, **kwargs):
1268
1041
self.bus = bus
1269
1042
Client.__init__(self, *args, **kwargs)
1043
self._approvals_pending = 0
1044
1045
self._approvals_pending = 0
1270
1046
# Only now, when this client is initialized, can it show up on
1271
1047
# the D-Bus
1272
client_object_name = str(self.name).translate(
1048
client_object_name = unicode(self.name).translate(
1273
1049
{ord("."): ord("_"),
1274
1050
ord("-"): ord("_")})
1275
self.dbus_object_path = dbus.ObjectPath(
1276
"/clients/" + client_object_name)
1051
self.dbus_object_path = (dbus.ObjectPath
1052
("/clients/" + client_object_name))
1277
1053
DBusObjectWithProperties.__init__(self, self.bus,
1278
1054
self.dbus_object_path)
1279
1280
def notifychangeproperty(transform_func, dbus_name,
1281
type_func=lambda x: x,
1282
variant_level=1,
1283
invalidate_only=False,
1284
_interface=_interface):
1055
1056
def notifychangeproperty(transform_func,
1057
dbus_name, type_func=lambda x: x,
1058
variant_level=1):
1285
1059
""" Modify a variable so that it's a property which announces
1286
1060
its changes to DBus.
1287
1061
1292
1066
to the D-Bus. Default: no transform
1293
1067
variant_level: D-Bus variant level. Default: 1
1294
1068
"""
1295
attrname = "_{}".format(dbus_name)
1296
1069
attrname = "_{0}".format(dbus_name)
1297
1070
def setter(self, value):
1298
1071
if hasattr(self, "dbus_object_path"):
1299
1072
if (not hasattr(self, attrname) or
1300
1073
type_func(getattr(self, attrname, None))
1301
1074
!= type_func(value)):
1302
if invalidate_only:
1303
self.PropertiesChanged(
1304
_interface, dbus.Dictionary(),
1305
dbus.Array((dbus_name, )))
1306
else:
1307
dbus_value = transform_func(
1308
type_func(value),
1309
variant_level = variant_level)
1310
self.PropertyChanged(dbus.String(dbus_name),
1311
dbus_value)
1312
self.PropertiesChanged(
1313
_interface,
1314
dbus.Dictionary({ dbus.String(dbus_name):
1315
dbus_value }),
1316
dbus.Array())
1075
dbus_value = transform_func(type_func(value),
1076
variant_level
1077
=variant_level)
1078
self.PropertyChanged(dbus.String(dbus_name),
1079
dbus_value)
1317
1080
setattr(self, attrname, value)
1318
1081
1319
1082
return property(lambda self: getattr(self, attrname), setter)
1320
1083
1084
1321
1085
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1322
1086
approvals_pending = notifychangeproperty(dbus.Boolean,
1323
1087
"ApprovalPending",
1325
1089
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1326
1090
last_enabled = notifychangeproperty(datetime_to_dbus,
1327
1091
"LastEnabled")
1328
checker = notifychangeproperty(
1329
dbus.Boolean, "CheckerRunning",
1330
type_func = lambda checker: checker is not None)
1092
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1093
type_func = lambda checker:
1094
checker is not None)
1331
1095
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1332
1096
"LastCheckedOK")
1333
last_checker_status = notifychangeproperty(dbus.Int16,
1334
"LastCheckerStatus")
1335
1097
last_approval_request = notifychangeproperty(
1336
1098
datetime_to_dbus, "LastApprovalRequest")
1337
1099
approved_by_default = notifychangeproperty(dbus.Boolean,
1338
1100
"ApprovedByDefault")
1339
approval_delay = notifychangeproperty(
1340
dbus.UInt64, "ApprovalDelay",
1341
type_func = lambda td: td.total_seconds() * 1000)
1101
approval_delay = notifychangeproperty(dbus.UInt64,
1102
"ApprovalDelay",
1103
type_func =
1104
timedelta_to_milliseconds)
1342
1105
approval_duration = notifychangeproperty(
1343
1106
dbus.UInt64, "ApprovalDuration",
1344
type_func = lambda td: td.total_seconds() * 1000)
1107
type_func = timedelta_to_milliseconds)
1345
1108
host = notifychangeproperty(dbus.String, "Host")
1346
timeout = notifychangeproperty(
1347
dbus.UInt64, "Timeout",
1348
type_func = lambda td: td.total_seconds() * 1000)
1109
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1110
type_func =
1111
timedelta_to_milliseconds)
1349
1112
extended_timeout = notifychangeproperty(
1350
1113
dbus.UInt64, "ExtendedTimeout",
1351
type_func = lambda td: td.total_seconds() * 1000)
1352
interval = notifychangeproperty(
1353
dbus.UInt64, "Interval",
1354
type_func = lambda td: td.total_seconds() * 1000)
1114
type_func = timedelta_to_milliseconds)
1115
interval = notifychangeproperty(dbus.UInt64,
1116
"Interval",
1117
type_func =
1118
timedelta_to_milliseconds)
1355
1119
checker_command = notifychangeproperty(dbus.String, "Checker")
1356
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1357
invalidate_only=True)
1358
1120
1359
1121
del notifychangeproperty
1360
1122
1367
1129
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1368
1130
Client.__del__(self, *args, **kwargs)
1369
1131
1370
def checker_callback(self, source, condition,
1371
connection, command, *args, **kwargs):
1372
ret = Client.checker_callback(self, source, condition,
1373
connection, command, *args,
1374
**kwargs)
1375
exitstatus = self.last_checker_status
1376
if exitstatus >= 0:
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)
1377
1138
# Emit D-Bus signal
1378
1139
self.CheckerCompleted(dbus.Int16(exitstatus),
1379
dbus.Int64(0),
1140
dbus.Int64(condition),
1380
1141
dbus.String(command))
1381
1142
else:
1382
1143
# Emit D-Bus signal
1383
1144
self.CheckerCompleted(dbus.Int16(-1),
1384
dbus.Int64(
1385
self.last_checker_signal),
1145
dbus.Int64(condition),
1386
1146
dbus.String(command))
1387
return ret
1147
1148
return Client.checker_callback(self, pid, condition, command,
1149
*args, **kwargs)
1388
1150
1389
1151
def start_checker(self, *args, **kwargs):
1390
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
1391
1157
r = Client.start_checker(self, *args, **kwargs)
1392
1158
# Only if new checker process was started
1393
1159
if (self.checker is not None
1401
1167
return False
1402
1168
1403
1169
def approve(self, value=True):
1170
self.send_changedstate()
1404
1171
self.approved = value
1405
gobject.timeout_add(int(self.approval_duration.total_seconds()
1406
* 1000), self._reset_approved)
1407
self.send_changedstate()
1172
gobject.timeout_add(timedelta_to_milliseconds
1173
(self.approval_duration),
1174
self._reset_approved)
1175
1408
1176
1409
1177
## D-Bus methods, signals & properties
1410
1411
## Interfaces
1178
_interface = "se.recompile.Mandos.Client"
1412
1179
1413
1180
## Signals
1414
1181
1425
1192
pass
1426
1193
1427
1194
# PropertyChanged - signal
1428
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1429
1195
@dbus.service.signal(_interface, signature="sv")
1430
1196
def PropertyChanged(self, property, value):
1431
1197
"D-Bus signal"
1452
1218
"D-Bus signal"
1453
1219
return self.need_approval()
1454
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
1455
1229
## Methods
1456
1230
1457
1231
# Approve - method
1495
1269
return dbus.Boolean(bool(self.approvals_pending))
1496
1270
1497
1271
# ApprovedByDefault - property
1498
@dbus_service_property(_interface,
1499
signature="b",
1272
@dbus_service_property(_interface, signature="b",
1500
1273
access="readwrite")
1501
1274
def ApprovedByDefault_dbus_property(self, value=None):
1502
1275
if value is None: # get
1504
1277
self.approved_by_default = bool(value)
1505
1278
1506
1279
# ApprovalDelay - property
1507
@dbus_service_property(_interface,
1508
signature="t",
1280
@dbus_service_property(_interface, signature="t",
1509
1281
access="readwrite")
1510
1282
def ApprovalDelay_dbus_property(self, value=None):
1511
1283
if value is None: # get
1512
return dbus.UInt64(self.approval_delay.total_seconds()
1513
* 1000)
1284
return dbus.UInt64(self.approval_delay_milliseconds())
1514
1285
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1515
1286
1516
1287
# ApprovalDuration - property
1517
@dbus_service_property(_interface,
1518
signature="t",
1288
@dbus_service_property(_interface, signature="t",
1519
1289
access="readwrite")
1520
1290
def ApprovalDuration_dbus_property(self, value=None):
1521
1291
if value is None: # get
1522
return dbus.UInt64(self.approval_duration.total_seconds()
1523
* 1000)
1292
return dbus.UInt64(timedelta_to_milliseconds(
1293
self.approval_duration))
1524
1294
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1525
1295
1526
1296
# Name - property
1534
1304
return dbus.String(self.fingerprint)
1535
1305
1536
1306
# Host - property
1537
@dbus_service_property(_interface,
1538
signature="s",
1307
@dbus_service_property(_interface, signature="s",
1539
1308
access="readwrite")
1540
1309
def Host_dbus_property(self, value=None):
1541
1310
if value is None: # get
1542
1311
return dbus.String(self.host)
1543
self.host = str(value)
1312
self.host = unicode(value)
1544
1313
1545
1314
# Created - property
1546
1315
@dbus_service_property(_interface, signature="s", access="read")
1553
1322
return datetime_to_dbus(self.last_enabled)
1554
1323
1555
1324
# Enabled - property
1556
@dbus_service_property(_interface,
1557
signature="b",
1325
@dbus_service_property(_interface, signature="b",
1558
1326
access="readwrite")
1559
1327
def Enabled_dbus_property(self, value=None):
1560
1328
if value is None: # get
1565
1333
self.disable()
1566
1334
1567
1335
# LastCheckedOK - property
1568
@dbus_service_property(_interface,
1569
signature="s",
1336
@dbus_service_property(_interface, signature="s",
1570
1337
access="readwrite")
1571
1338
def LastCheckedOK_dbus_property(self, value=None):
1572
1339
if value is not None:
1574
1341
return
1575
1342
return datetime_to_dbus(self.last_checked_ok)
1576
1343
1577
# LastCheckerStatus - property
1578
@dbus_service_property(_interface, signature="n", access="read")
1579
def LastCheckerStatus_dbus_property(self):
1580
return dbus.Int16(self.last_checker_status)
1581
1582
1344
# Expires - property
1583
1345
@dbus_service_property(_interface, signature="s", access="read")
1584
1346
def Expires_dbus_property(self):
1590
1352
return datetime_to_dbus(self.last_approval_request)
1591
1353
1592
1354
# Timeout - property
1593
@dbus_service_property(_interface,
1594
signature="t",
1355
@dbus_service_property(_interface, signature="t",
1595
1356
access="readwrite")
1596
1357
def Timeout_dbus_property(self, value=None):
1597
1358
if value is None: # get
1598
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1599
old_timeout = self.timeout
1359
return dbus.UInt64(self.timeout_milliseconds())
1600
1360
self.timeout = datetime.timedelta(0, 0, 0, value)
1601
# Reschedule disabling
1602
if self.enabled:
1603
now = datetime.datetime.utcnow()
1604
self.expires += self.timeout - old_timeout
1605
if self.expires <= now:
1606
# The timeout has passed
1607
self.disable()
1608
else:
1609
if (getattr(self, "disable_initiator_tag", None)
1610
is None):
1611
return
1612
gobject.source_remove(self.disable_initiator_tag)
1613
self.disable_initiator_tag = gobject.timeout_add(
1614
int((self.expires - now).total_seconds() * 1000),
1615
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))
1616
1381
1617
1382
# ExtendedTimeout - property
1618
@dbus_service_property(_interface,
1619
signature="t",
1383
@dbus_service_property(_interface, signature="t",
1620
1384
access="readwrite")
1621
1385
def ExtendedTimeout_dbus_property(self, value=None):
1622
1386
if value is None: # get
1623
return dbus.UInt64(self.extended_timeout.total_seconds()
1624
* 1000)
1387
return dbus.UInt64(self.extended_timeout_milliseconds())
1625
1388
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1626
1389
1627
1390
# Interval - property
1628
@dbus_service_property(_interface,
1629
signature="t",
1391
@dbus_service_property(_interface, signature="t",
1630
1392
access="readwrite")
1631
1393
def Interval_dbus_property(self, value=None):
1632
1394
if value is None: # get
1633
return dbus.UInt64(self.interval.total_seconds() * 1000)
1395
return dbus.UInt64(self.interval_milliseconds())
1634
1396
self.interval = datetime.timedelta(0, 0, 0, value)
1635
1397
if getattr(self, "checker_initiator_tag", None) is None:
1636
1398
return
1637
1399
if self.enabled:
1638
1400
# Reschedule checker run
1639
1401
gobject.source_remove(self.checker_initiator_tag)
1640
self.checker_initiator_tag = gobject.timeout_add(
1641
value, self.start_checker)
1642
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
1643
1405
1644
1406
# Checker - property
1645
@dbus_service_property(_interface,
1646
signature="s",
1407
@dbus_service_property(_interface, signature="s",
1647
1408
access="readwrite")
1648
1409
def Checker_dbus_property(self, value=None):
1649
1410
if value is None: # get
1650
1411
return dbus.String(self.checker_command)
1651
self.checker_command = str(value)
1412
self.checker_command = unicode(value)
1652
1413
1653
1414
# CheckerRunning - property
1654
@dbus_service_property(_interface,
1655
signature="b",
1415
@dbus_service_property(_interface, signature="b",
1656
1416
access="readwrite")
1657
1417
def CheckerRunning_dbus_property(self, value=None):
1658
1418
if value is None: # get
1668
1428
return self.dbus_object_path # is already a dbus.ObjectPath
1669
1429
1670
1430
# Secret = property
1671
@dbus_service_property(_interface,
1672
signature="ay",
1673
access="write",
1674
byte_arrays=True)
1431
@dbus_service_property(_interface, signature="ay",
1432
access="write", byte_arrays=True)
1675
1433
def Secret_dbus_property(self, value):
1676
self.secret = bytes(value)
1434
self.secret = str(value)
1677
1435
1678
1436
del _interface
1679
1437
1683
1441
self._pipe = child_pipe
1684
1442
self._pipe.send(('init', fpr, address))
1685
1443
if not self._pipe.recv():
1686
raise KeyError(fpr)
1444
raise KeyError()
1687
1445
1688
1446
def __getattribute__(self, name):
1689
1447
if name == '_pipe':
1693
1451
if data[0] == 'data':
1694
1452
return data[1]
1695
1453
if data[0] == 'function':
1696
1697
1454
def func(*args, **kwargs):
1698
1455
self._pipe.send(('funcall', name, args, kwargs))
1699
1456
return self._pipe.recv()[1]
1700
1701
1457
return func
1702
1458
1703
1459
def __setattr__(self, name, value):
1706
1462
self._pipe.send(('setattr', name, value))
1707
1463
1708
1464
1465
class ClientDBusTransitional(ClientDBus):
1466
__metaclass__ = AlternateDBusNamesMetaclass
1467
1468
1709
1469
class ClientHandler(socketserver.BaseRequestHandler, object):
1710
1470
"""A class to handle client connections.
1711
1471
1715
1475
def handle(self):
1716
1476
with contextlib.closing(self.server.child_pipe) as child_pipe:
1717
1477
logger.info("TCP connection from: %s",
1718
str(self.client_address))
1478
unicode(self.client_address))
1719
1479
logger.debug("Pipe FD: %d",
1720
1480
self.server.child_pipe.fileno())
1721
1481
1722
session = gnutls.connection.ClientSession(
1723
self.request, gnutls.connection .X509Credentials())
1482
session = (gnutls.connection
1483
.ClientSession(self.request,
1484
gnutls.connection
1485
.X509Credentials()))
1724
1486
1725
1487
# Note: gnutls.connection.X509Credentials is really a
1726
1488
# generic GnuTLS certificate credentials object so long as
1735
1497
priority = self.server.gnutls_priority
1736
1498
if priority is None:
1737
1499
priority = "NORMAL"
1738
gnutls.library.functions.gnutls_priority_set_direct(
1739
session._c_object, priority, None)
1500
(gnutls.library.functions
1501
.gnutls_priority_set_direct(session._c_object,
1502
priority, None))
1740
1503
1741
1504
# Start communication using the Mandos protocol
1742
1505
# Get protocol number
1744
1507
logger.debug("Protocol version: %r", line)
1745
1508
try:
1746
1509
if int(line.strip().split()[0]) > 1:
1747
raise RuntimeError(line)
1510
raise RuntimeError
1748
1511
except (ValueError, IndexError, RuntimeError) as error:
1749
1512
logger.error("Unknown protocol version: %s", error)
1750
1513
return
1762
1525
approval_required = False
1763
1526
try:
1764
1527
try:
1765
fpr = self.fingerprint(
1766
self.peer_certificate(session))
1528
fpr = self.fingerprint(self.peer_certificate
1529
(session))
1767
1530
except (TypeError,
1768
1531
gnutls.errors.GNUTLSError) as error:
1769
1532
logger.warning("Bad certificate: %s", error)
1776
1539
except KeyError:
1777
1540
return
1778
1541
1542
if self.server.use_dbus:
1543
# Emit D-Bus signal
1544
client.NewRequest(str(self.client_address))
1545
1779
1546
if client.approval_delay:
1780
1547
delay = client.approval_delay
1781
1548
client.approvals_pending += 1
1784
1551
while True:
1785
1552
if not client.enabled:
1786
1553
logger.info("Client %s is disabled",
1787
client.name)
1554
client.name)
1788
1555
if self.server.use_dbus:
1789
1556
# Emit D-Bus signal
1790
1557
client.Rejected("Disabled")
1799
1566
if self.server.use_dbus:
1800
1567
# Emit D-Bus signal
1801
1568
client.NeedApproval(
1802
client.approval_delay.total_seconds()
1803
* 1000, client.approved_by_default)
1569
client.approval_delay_milliseconds(),
1570
client.approved_by_default)
1804
1571
else:
1805
1572
logger.warning("Client %s was not approved",
1806
1573
client.name)
1812
1579
#wait until timeout or approved
1813
1580
time = datetime.datetime.now()
1814
1581
client.changedstate.acquire()
1815
client.changedstate.wait(delay.total_seconds())
1582
(client.changedstate.wait
1583
(float(client.timedelta_to_milliseconds(delay)
1584
/ 1000)))
1816
1585
client.changedstate.release()
1817
1586
time2 = datetime.datetime.now()
1818
1587
if (time2 - time) >= delay:
1834
1603
try:
1835
1604
sent = session.send(client.secret[sent_size:])
1836
1605
except gnutls.errors.GNUTLSError as error:
1837
logger.warning("gnutls send failed",
1838
exc_info=error)
1606
logger.warning("gnutls send failed")
1839
1607
return
1840
logger.debug("Sent: %d, remaining: %d", sent,
1841
len(client.secret) - (sent_size
1842
+ sent))
1608
logger.debug("Sent: %d, remaining: %d",
1609
sent, len(client.secret)
1610
- (sent_size + sent))
1843
1611
sent_size += sent
1844
1612
1845
1613
logger.info("Sending secret to %s", client.name)
1846
1614
# bump the timeout using extended_timeout
1847
client.bump_timeout(client.extended_timeout)
1615
client.checked_ok(client.extended_timeout)
1848
1616
if self.server.use_dbus:
1849
1617
# Emit D-Bus signal
1850
1618
client.GotSecret()
1855
1623
try:
1856
1624
session.bye()
1857
1625
except gnutls.errors.GNUTLSError as error:
1858
logger.warning("GnuTLS bye failed",
1859
exc_info=error)
1626
logger.warning("GnuTLS bye failed")
1860
1627
1861
1628
@staticmethod
1862
1629
def peer_certificate(session):
1863
1630
"Return the peer's OpenPGP certificate as a bytestring"
1864
1631
# If not an OpenPGP certificate...
1865
if (gnutls.library.functions.gnutls_certificate_type_get(
1866
session._c_object)
1632
if (gnutls.library.functions
1633
.gnutls_certificate_type_get(session._c_object)
1867
1634
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1868
1635
# ...do the normal thing
1869
1636
return session.peer_certificate
1883
1650
def fingerprint(openpgp):
1884
1651
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1885
1652
# New GnuTLS "datum" with the OpenPGP public key
1886
datum = gnutls.library.types.gnutls_datum_t(
1887
ctypes.cast(ctypes.c_char_p(openpgp),
1888
ctypes.POINTER(ctypes.c_ubyte)),
1889
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))))
1890
1658
# New empty GnuTLS certificate
1891
1659
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1892
gnutls.library.functions.gnutls_openpgp_crt_init(
1893
ctypes.byref(crt))
1660
(gnutls.library.functions
1661
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1894
1662
# Import the OpenPGP public key into the certificate
1895
gnutls.library.functions.gnutls_openpgp_crt_import(
1896
crt, ctypes.byref(datum),
1897
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))
1898
1667
# Verify the self signature in the key
1899
1668
crtverify = ctypes.c_uint()
1900
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1901
crt, 0, ctypes.byref(crtverify))
1669
(gnutls.library.functions
1670
.gnutls_openpgp_crt_verify_self(crt, 0,
1671
ctypes.byref(crtverify)))
1902
1672
if crtverify.value != 0:
1903
1673
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1904
raise gnutls.errors.CertificateSecurityError(
1905
"Verify failed")
1674
raise (gnutls.errors.CertificateSecurityError
1675
("Verify failed"))
1906
1676
# New buffer for the fingerprint
1907
1677
buf = ctypes.create_string_buffer(20)
1908
1678
buf_len = ctypes.c_size_t()
1909
1679
# Get the fingerprint from the certificate into the buffer
1910
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1911
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)))
1912
1683
# Deinit the certificate
1913
1684
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1914
1685
# Convert the buffer to a Python bytestring
1920
1691
1921
1692
class MultiprocessingMixIn(object):
1922
1693
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1923
1924
1694
def sub_process_main(self, request, address):
1925
1695
try:
1926
1696
self.finish_request(request, address)
1931
1701
def process_request(self, request, address):
1932
1702
"""Start a new process to process the request."""
1933
1703
proc = multiprocessing.Process(target = self.sub_process_main,
1934
args = (request, address))
1704
args = (request,
1705
address))
1935
1706
proc.start()
1936
1707
return proc
1937
1708
1938
1709
1939
1710
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1940
1711
""" adds a pipe to the MixIn """
1941
1942
1712
def process_request(self, request, client_address):
1943
1713
"""Overrides and wraps the original process_request().
1944
1714
1953
1723
1954
1724
def add_pipe(self, parent_pipe, proc):
1955
1725
"""Dummy function; override as necessary"""
1956
raise NotImplementedError()
1726
raise NotImplementedError
1957
1727
1958
1728
1959
1729
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1965
1735
interface: None or a network interface name (string)
1966
1736
use_ipv6: Boolean; to use IPv6 or not
1967
1737
"""
1968
1969
1738
def __init__(self, server_address, RequestHandlerClass,
1970
interface=None,
1971
use_ipv6=True,
1972
socketfd=None):
1973
"""If socketfd is set, use that file descriptor instead of
1974
creating a new one with socket.socket().
1975
"""
1739
interface=None, use_ipv6=True):
1976
1740
self.interface = interface
1977
1741
if use_ipv6:
1978
1742
self.address_family = socket.AF_INET6
1979
if socketfd is not None:
1980
# Save the file descriptor
1981
self.socketfd = socketfd
1982
# Save the original socket.socket() function
1983
self.socket_socket = socket.socket
1984
# To implement --socket, we monkey patch socket.socket.
1985
#
1986
# (When socketserver.TCPServer is a new-style class, we
1987
# could make self.socket into a property instead of monkey
1988
# patching socket.socket.)
1989
#
1990
# Create a one-time-only replacement for socket.socket()
1991
@functools.wraps(socket.socket)
1992
def socket_wrapper(*args, **kwargs):
1993
# Restore original function so subsequent calls are
1994
# not affected.
1995
socket.socket = self.socket_socket
1996
del self.socket_socket
1997
# This time only, return a new socket object from the
1998
# saved file descriptor.
1999
return socket.fromfd(self.socketfd, *args, **kwargs)
2000
# Replace socket.socket() function with wrapper
2001
socket.socket = socket_wrapper
2002
# The socketserver.TCPServer.__init__ will call
2003
# socket.socket(), which might be our replacement,
2004
# socket_wrapper(), if socketfd was set.
2005
1743
socketserver.TCPServer.__init__(self, server_address,
2006
1744
RequestHandlerClass)
2007
2008
1745
def server_bind(self):
2009
1746
"""This overrides the normal server_bind() function
2010
1747
to bind to an interface if one was specified, and also NOT to
2016
1753
self.interface)
2017
1754
else:
2018
1755
try:
2019
self.socket.setsockopt(
2020
socket.SOL_SOCKET, SO_BINDTODEVICE,
2021
(self.interface + "\0").encode("utf-8"))
1756
self.socket.setsockopt(socket.SOL_SOCKET,
1757
SO_BINDTODEVICE,
1758
str(self.interface
1759
+ '\0'))
2022
1760
except socket.error as error:
2023
if error.errno == errno.EPERM:
2024
logger.error("No permission to bind to"
2025
" interface %s", self.interface)
2026
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:
2027
1766
logger.error("SO_BINDTODEVICE not available;"
2028
1767
" cannot bind to interface %s",
2029
1768
self.interface)
2030
elif error.errno == errno.ENODEV:
2031
logger.error("Interface %s does not exist,"
2032
" cannot bind", self.interface)
2033
1769
else:
2034
1770
raise
2035
1771
# Only bind(2) the socket if we really need to.
2038
1774
if self.address_family == socket.AF_INET6:
2039
1775
any_address = "::" # in6addr_any
2040
1776
else:
2041
any_address = "0.0.0.0" # INADDR_ANY
1777
any_address = socket.INADDR_ANY
2042
1778
self.server_address = (any_address,
2043
1779
self.server_address[1])
2044
1780
elif not self.server_address[1]:
2045
self.server_address = (self.server_address[0], 0)
1781
self.server_address = (self.server_address[0],
1782
0)
2046
1783
# if self.interface:
2047
1784
# self.server_address = (self.server_address[0],
2048
1785
# 0, # port
2062
1799
2063
1800
Assumes a gobject.MainLoop event loop.
2064
1801
"""
2065
2066
1802
def __init__(self, server_address, RequestHandlerClass,
2067
interface=None,
2068
use_ipv6=True,
2069
clients=None,
2070
gnutls_priority=None,
2071
use_dbus=True,
2072
socketfd=None):
1803
interface=None, use_ipv6=True, clients=None,
1804
gnutls_priority=None, use_dbus=True):
2073
1805
self.enabled = False
2074
1806
self.clients = clients
2075
1807
if self.clients is None:
2079
1811
IPv6_TCPServer.__init__(self, server_address,
2080
1812
RequestHandlerClass,
2081
1813
interface = interface,
2082
use_ipv6 = use_ipv6,
2083
socketfd = socketfd)
2084
1814
use_ipv6 = use_ipv6)
2085
1815
def server_activate(self):
2086
1816
if self.enabled:
2087
1817
return socketserver.TCPServer.server_activate(self)
2091
1821
2092
1822
def add_pipe(self, parent_pipe, proc):
2093
1823
# Call "handle_ipc" for both data and EOF events
2094
gobject.io_add_watch(
2095
parent_pipe.fileno(),
2096
gobject.IO_IN | gobject.IO_HUP,
2097
functools.partial(self.handle_ipc,
2098
parent_pipe = parent_pipe,
2099
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))
2100
1830
2101
def handle_ipc(self, source, condition,
2102
parent_pipe=None,
2103
proc = None,
2104
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)
2105
1847
# error, or the other end of multiprocessing.Pipe has closed
2106
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1848
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2107
1849
# Wait for other process to exit
2108
1850
proc.join()
2109
1851
return False
2130
1872
parent_pipe.send(False)
2131
1873
return False
2132
1874
2133
gobject.io_add_watch(
2134
parent_pipe.fileno(),
2135
gobject.IO_IN | gobject.IO_HUP,
2136
functools.partial(self.handle_ipc,
2137
parent_pipe = parent_pipe,
2138
proc = proc,
2139
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))
2140
1883
parent_pipe.send(True)
2141
1884
# remove the old hook in favor of the new above hook on
2142
1885
# same fileno
2148
1891
2149
1892
parent_pipe.send(('data', getattr(client_object,
2150
1893
funcname)(*args,
2151
**kwargs)))
1894
**kwargs)))
2152
1895
2153
1896
if command == 'getattr':
2154
1897
attrname = request[1]
2155
if isinstance(client_object.__getattribute__(attrname),
2156
collections.Callable):
2157
parent_pipe.send(('function', ))
1898
if callable(client_object.__getattribute__(attrname)):
1899
parent_pipe.send(('function',))
2158
1900
else:
2159
parent_pipe.send((
2160
'data', client_object.__getattribute__(attrname)))
1901
parent_pipe.send(('data', client_object
1902
.__getattribute__(attrname)))
2161
1903
2162
1904
if command == 'setattr':
2163
1905
attrname = request[1]
2167
1909
return True
2168
1910
2169
1911
2170
def rfc3339_duration_to_delta(duration):
2171
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2172
2173
>>> rfc3339_duration_to_delta("P7D")
2174
datetime.timedelta(7)
2175
>>> rfc3339_duration_to_delta("PT60S")
2176
datetime.timedelta(0, 60)
2177
>>> rfc3339_duration_to_delta("PT60M")
2178
datetime.timedelta(0, 3600)
2179
>>> rfc3339_duration_to_delta("PT24H")
2180
datetime.timedelta(1)
2181
>>> rfc3339_duration_to_delta("P1W")
2182
datetime.timedelta(7)
2183
>>> rfc3339_duration_to_delta("PT5M30S")
2184
datetime.timedelta(0, 330)
2185
>>> rfc3339_duration_to_delta("P1DT3M20S")
2186
datetime.timedelta(1, 200)
2187
"""
2188
2189
# Parsing an RFC 3339 duration with regular expressions is not
2190
# possible - there would have to be multiple places for the same
2191
# values, like seconds. The current code, while more esoteric, is
2192
# cleaner without depending on a parsing library. If Python had a
2193
# built-in library for parsing we would use it, but we'd like to
2194
# avoid excessive use of external libraries.
2195
2196
# New type for defining tokens, syntax, and semantics all-in-one
2197
Token = collections.namedtuple("Token", (
2198
"regexp", # To match token; if "value" is not None, must have
2199
# a "group" containing digits
2200
"value", # datetime.timedelta or None
2201
"followers")) # Tokens valid after this token
2202
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2203
# the "duration" ABNF definition in RFC 3339, Appendix A.
2204
token_end = Token(re.compile(r"$"), None, frozenset())
2205
token_second = Token(re.compile(r"(\d+)S"),
2206
datetime.timedelta(seconds=1),
2207
frozenset((token_end, )))
2208
token_minute = Token(re.compile(r"(\d+)M"),
2209
datetime.timedelta(minutes=1),
2210
frozenset((token_second, token_end)))
2211
token_hour = Token(re.compile(r"(\d+)H"),
2212
datetime.timedelta(hours=1),
2213
frozenset((token_minute, token_end)))
2214
token_time = Token(re.compile(r"T"),
2215
None,
2216
frozenset((token_hour, token_minute,
2217
token_second)))
2218
token_day = Token(re.compile(r"(\d+)D"),
2219
datetime.timedelta(days=1),
2220
frozenset((token_time, token_end)))
2221
token_month = Token(re.compile(r"(\d+)M"),
2222
datetime.timedelta(weeks=4),
2223
frozenset((token_day, token_end)))
2224
token_year = Token(re.compile(r"(\d+)Y"),
2225
datetime.timedelta(weeks=52),
2226
frozenset((token_month, token_end)))
2227
token_week = Token(re.compile(r"(\d+)W"),
2228
datetime.timedelta(weeks=1),
2229
frozenset((token_end, )))
2230
token_duration = Token(re.compile(r"P"), None,
2231
frozenset((token_year, token_month,
2232
token_day, token_time,
2233
token_week)))
2234
# Define starting values
2235
value = datetime.timedelta() # Value so far
2236
found_token = None
2237
followers = frozenset((token_duration, )) # Following valid tokens
2238
s = duration # String left to parse
2239
# Loop until end token is found
2240
while found_token is not token_end:
2241
# Search for any currently valid tokens
2242
for token in followers:
2243
match = token.regexp.match(s)
2244
if match is not None:
2245
# Token found
2246
if token.value is not None:
2247
# Value found, parse digits
2248
factor = int(match.group(1), 10)
2249
# Add to value so far
2250
value += factor * token.value
2251
# Strip token from string
2252
s = token.regexp.sub("", s, 1)
2253
# Go to found token
2254
found_token = token
2255
# Set valid next tokens
2256
followers = found_token.followers
2257
break
2258
else:
2259
# No currently valid tokens were found
2260
raise ValueError("Invalid RFC 3339 duration: {!r}"
2261
.format(duration))
2262
# End token found
2263
return value
2264
2265
2266
1912
def string_to_delta(interval):
2267
1913
"""Parse a string and return a datetime.timedelta
2268
1914
2279
1925
>>> string_to_delta('5m 30s')
2280
1926
datetime.timedelta(0, 330)
2281
1927
"""
2282
2283
try:
2284
return rfc3339_duration_to_delta(interval)
2285
except ValueError:
2286
pass
2287
2288
1928
timevalue = datetime.timedelta(0)
2289
1929
for s in interval.split():
2290
1930
try:
2291
suffix = s[-1]
1931
suffix = unicode(s[-1])
2292
1932
value = int(s[:-1])
2293
1933
if suffix == "d":
2294
1934
delta = datetime.timedelta(value)
2301
1941
elif suffix == "w":
2302
1942
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2303
1943
else:
2304
raise ValueError("Unknown suffix {!r}".format(suffix))
2305
except IndexError as e:
1944
raise ValueError("Unknown suffix %r" % suffix)
1945
except (ValueError, IndexError) as e:
2306
1946
raise ValueError(*(e.args))
2307
1947
timevalue += delta
2308
1948
return timevalue
2321
1961
sys.exit()
2322
1962
if not noclose:
2323
1963
# Close all standard open file descriptors
2324
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1964
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2325
1965
if not stat.S_ISCHR(os.fstat(null).st_mode):
2326
1966
raise OSError(errno.ENODEV,
2327
"{} not a character device"
2328
.format(os.devnull))
1967
"%s not a character device"
1968
% os.path.devnull)
2329
1969
os.dup2(null, sys.stdin.fileno())
2330
1970
os.dup2(null, sys.stdout.fileno())
2331
1971
os.dup2(null, sys.stderr.fileno())
2340
1980
2341
1981
parser = argparse.ArgumentParser()
2342
1982
parser.add_argument("-v", "--version", action="version",
2343
version = "%(prog)s {}".format(version),
1983
version = "%%(prog)s %s" % version,
2344
1984
help="show version number and exit")
2345
1985
parser.add_argument("-i", "--interface", metavar="IF",
2346
1986
help="Bind to interface IF")
2352
1992
help="Run self-test")
2353
1993
parser.add_argument("--debug", action="store_true",
2354
1994
help="Debug mode; run in foreground and log"
2355
" to terminal", default=None)
1995
" to terminal")
2356
1996
parser.add_argument("--debuglevel", metavar="LEVEL",
2357
1997
help="Debug level for stdout output")
2358
1998
parser.add_argument("--priority", help="GnuTLS"
2365
2005
" files")
2366
2006
parser.add_argument("--no-dbus", action="store_false",
2367
2007
dest="use_dbus", help="Do not provide D-Bus"
2368
" system bus interface", default=None)
2008
" system bus interface")
2369
2009
parser.add_argument("--no-ipv6", action="store_false",
2370
dest="use_ipv6", help="Do not use IPv6",
2371
default=None)
2010
dest="use_ipv6", help="Do not use IPv6")
2372
2011
parser.add_argument("--no-restore", action="store_false",
2373
2012
dest="restore", help="Do not restore stored"
2374
" state", default=None)
2375
parser.add_argument("--socket", type=int,
2376
help="Specify a file descriptor to a network"
2377
" socket to use instead of creating one")
2013
" state")
2378
2014
parser.add_argument("--statedir", metavar="DIR",
2379
2015
help="Directory to save/restore state in")
2380
parser.add_argument("--foreground", action="store_true",
2381
help="Run in foreground", default=None)
2382
parser.add_argument("--no-zeroconf", action="store_false",
2383
dest="zeroconf", help="Do not use Zeroconf",
2384
default=None)
2385
2016
2386
2017
options = parser.parse_args()
2387
2018
2388
2019
if options.check:
2389
2020
import doctest
2390
fail_count, test_count = doctest.testmod()
2391
sys.exit(os.EX_OK if fail_count == 0 else 1)
2021
doctest.testmod()
2022
sys.exit()
2392
2023
2393
2024
# Default values for config file for server-global settings
2394
2025
server_defaults = { "interface": "",
2396
2027
"port": "",
2397
2028
"debug": "False",
2398
2029
"priority":
2399
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2400
":+SIGN-DSA-SHA256",
2030
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2401
2031
"servicename": "Mandos",
2402
2032
"use_dbus": "True",
2403
2033
"use_ipv6": "True",
2404
2034
"debuglevel": "",
2405
2035
"restore": "True",
2406
"socket": "",
2407
"statedir": "/var/lib/mandos",
2408
"foreground": "False",
2409
"zeroconf": "True",
2410
}
2036
"statedir": "/var/lib/mandos"
2037
}
2411
2038
2412
2039
# Parse config file for server-global settings
2413
2040
server_config = configparser.SafeConfigParser(server_defaults)
2414
2041
del server_defaults
2415
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2042
server_config.read(os.path.join(options.configdir,
2043
"mandos.conf"))
2416
2044
# Convert the SafeConfigParser object to a dict
2417
2045
server_settings = server_config.defaults()
2418
2046
# Use the appropriate methods on the non-string config options
2419
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2047
for option in ("debug", "use_dbus", "use_ipv6"):
2420
2048
server_settings[option] = server_config.getboolean("DEFAULT",
2421
2049
option)
2422
2050
if server_settings["port"]:
2423
2051
server_settings["port"] = server_config.getint("DEFAULT",
2424
2052
"port")
2425
if server_settings["socket"]:
2426
server_settings["socket"] = server_config.getint("DEFAULT",
2427
"socket")
2428
# Later, stdin will, and stdout and stderr might, be dup'ed
2429
# over with an opened os.devnull. But we don't want this to
2430
# happen with a supplied network socket.
2431
if 0 <= server_settings["socket"] <= 2:
2432
server_settings["socket"] = os.dup(server_settings
2433
["socket"])
2434
2053
del server_config
2435
2054
2436
2055
# Override the settings from the config file with command line
2437
2056
# options, if set.
2438
2057
for option in ("interface", "address", "port", "debug",
2439
"priority", "servicename", "configdir", "use_dbus",
2440
"use_ipv6", "debuglevel", "restore", "statedir",
2441
"socket", "foreground", "zeroconf"):
2058
"priority", "servicename", "configdir",
2059
"use_dbus", "use_ipv6", "debuglevel", "restore",
2060
"statedir"):
2442
2061
value = getattr(options, option)
2443
2062
if value is not None:
2444
2063
server_settings[option] = value
2445
2064
del options
2446
2065
# Force all strings to be unicode
2447
2066
for option in server_settings.keys():
2448
if isinstance(server_settings[option], bytes):
2449
server_settings[option] = (server_settings[option]
2450
.decode("utf-8"))
2451
# Force all boolean options to be boolean
2452
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2453
"foreground", "zeroconf"):
2454
server_settings[option] = bool(server_settings[option])
2455
# Debug implies foreground
2456
if server_settings["debug"]:
2457
server_settings["foreground"] = True
2067
if type(server_settings[option]) is str:
2068
server_settings[option] = unicode(server_settings[option])
2458
2069
# Now we have our good server settings in "server_settings"
2459
2070
2460
2071
##################################################################
2461
2072
2462
if (not server_settings["zeroconf"]
2463
and not (server_settings["port"]
2464
or server_settings["socket"] != "")):
2465
parser.error("Needs port or socket to work without Zeroconf")
2466
2467
2073
# For convenience
2468
2074
debug = server_settings["debug"]
2469
2075
debuglevel = server_settings["debuglevel"]
2471
2077
use_ipv6 = server_settings["use_ipv6"]
2472
2078
stored_state_path = os.path.join(server_settings["statedir"],
2473
2079
stored_state_file)
2474
foreground = server_settings["foreground"]
2475
zeroconf = server_settings["zeroconf"]
2476
2080
2477
2081
if debug:
2478
2082
initlogger(debug, logging.DEBUG)
2484
2088
initlogger(debug, level)
2485
2089
2486
2090
if server_settings["servicename"] != "Mandos":
2487
syslogger.setFormatter(
2488
logging.Formatter('Mandos ({}) [%(process)d]:'
2489
' %(levelname)s: %(message)s'.format(
2490
server_settings["servicename"])))
2091
syslogger.setFormatter(logging.Formatter
2092
('Mandos (%s) [%%(process)d]:'
2093
' %%(levelname)s: %%(message)s'
2094
% server_settings["servicename"]))
2491
2095
2492
2096
# Parse config file with clients
2493
client_config = configparser.SafeConfigParser(Client
2494
.client_defaults)
2097
client_config = configparser.SafeConfigParser(Client.client_defaults)
2495
2098
client_config.read(os.path.join(server_settings["configdir"],
2496
2099
"clients.conf"))
2497
2100
2498
2101
global mandos_dbus_service
2499
2102
mandos_dbus_service = None
2500
2103
2501
socketfd = None
2502
if server_settings["socket"] != "":
2503
socketfd = server_settings["socket"]
2504
tcp_server = MandosServer(
2505
(server_settings["address"], server_settings["port"]),
2506
ClientHandler,
2507
interface=(server_settings["interface"] or None),
2508
use_ipv6=use_ipv6,
2509
gnutls_priority=server_settings["priority"],
2510
use_dbus=use_dbus,
2511
socketfd=socketfd)
2512
if not foreground:
2513
pidfilename = "/run/mandos.pid"
2514
if not os.path.isdir("/run/."):
2515
pidfilename = "/var/run/mandos.pid"
2516
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"
2517
2115
try:
2518
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2519
except IOError as e:
2520
logger.error("Could not open file %r", pidfilename,
2521
exc_info=e)
2116
pidfile = open(pidfilename, "w")
2117
except IOError:
2118
logger.error("Could not open file %r", pidfilename)
2522
2119
2523
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:
2524
2124
try:
2525
uid = pwd.getpwnam(name).pw_uid
2526
gid = pwd.getpwnam(name).pw_gid
2527
break
2125
uid = pwd.getpwnam("mandos").pw_uid
2126
gid = pwd.getpwnam("mandos").pw_gid
2528
2127
except KeyError:
2529
continue
2530
else:
2531
uid = 65534
2532
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
2533
2134
try:
2534
2135
os.setgid(gid)
2535
2136
os.setuid(uid)
2536
2137
except OSError as error:
2537
if error.errno != errno.EPERM:
2538
raise
2138
if error[0] != errno.EPERM:
2139
raise error
2539
2140
2540
2141
if debug:
2541
2142
# Enable all possible GnuTLS debugging
2548
2149
def debug_gnutls(level, string):
2549
2150
logger.debug("GnuTLS: %s", string[:-1])
2550
2151
2551
gnutls.library.functions.gnutls_global_set_log_function(
2552
debug_gnutls)
2152
(gnutls.library.functions
2153
.gnutls_global_set_log_function(debug_gnutls))
2553
2154
2554
2155
# Redirect stdin so all checkers get /dev/null
2555
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2156
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2556
2157
os.dup2(null, sys.stdin.fileno())
2557
2158
if null > 2:
2558
2159
os.close(null)
2559
2160
2560
2161
# Need to fork before connecting to D-Bus
2561
if not foreground:
2162
if not debug:
2562
2163
# Close all input and output, do double fork, etc.
2563
2164
daemon()
2564
2165
2565
# multiprocessing will use threads, so before we use gobject we
2566
# need to inform gobject that threads will be used.
2567
2166
gobject.threads_init()
2568
2167
2569
2168
global main_loop
2570
2169
# From the Avahi example code
2571
DBusGMainLoop(set_as_default=True)
2170
DBusGMainLoop(set_as_default=True )
2572
2171
main_loop = gobject.MainLoop()
2573
2172
bus = dbus.SystemBus()
2574
2173
# End of Avahi example code
2575
2174
if use_dbus:
2576
2175
try:
2577
2176
bus_name = dbus.service.BusName("se.recompile.Mandos",
2578
bus,
2579
do_not_queue=True)
2580
old_bus_name = dbus.service.BusName(
2581
"se.bsnet.fukt.Mandos", bus,
2582
do_not_queue=True)
2583
except dbus.exceptions.DBusException as e:
2584
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")
2585
2183
use_dbus = False
2586
2184
server_settings["use_dbus"] = False
2587
2185
tcp_server.use_dbus = False
2588
if zeroconf:
2589
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2590
service = AvahiServiceToSyslog(
2591
name = server_settings["servicename"],
2592
servicetype = "_mandos._tcp",
2593
protocol = protocol,
2594
bus = bus)
2595
if server_settings["interface"]:
2596
service.interface = if_nametoindex(
2597
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"])))
2598
2194
2599
2195
global multiprocessing_manager
2600
2196
multiprocessing_manager = multiprocessing.Manager()
2601
2197
2602
2198
client_class = Client
2603
2199
if use_dbus:
2604
client_class = functools.partial(ClientDBus, bus = bus)
2200
client_class = functools.partial(ClientDBusTransitional,
2201
bus = bus)
2605
2202
2606
2203
client_settings = Client.config_parser(client_config)
2607
2204
old_client_settings = {}
2608
2205
clients_data = {}
2609
2206
2610
# This is used to redirect stdout and stderr for checker processes
2611
global wnull
2612
wnull = open(os.devnull, "w") # A writable /dev/null
2613
# Only used if server is running in foreground but not in debug
2614
# mode
2615
if debug or not foreground:
2616
wnull.close()
2617
2618
2207
# Get client data and settings from last running state.
2619
2208
if server_settings["restore"]:
2620
2209
try:
2621
2210
with open(stored_state_path, "rb") as stored_state:
2622
clients_data, old_client_settings = pickle.load(
2623
stored_state)
2211
clients_data, old_client_settings = (pickle.load
2212
(stored_state))
2624
2213
os.remove(stored_state_path)
2625
2214
except IOError as e:
2626
if e.errno == errno.ENOENT:
2627
logger.warning("Could not load persistent state:"
2628
" {}".format(os.strerror(e.errno)))
2629
else:
2630
logger.critical("Could not load persistent state:",
2631
exc_info=e)
2215
logger.warning("Could not load persistent state: {0}"
2216
.format(e))
2217
if e.errno != errno.ENOENT:
2632
2218
raise
2633
2219
except EOFError as e:
2634
2220
logger.warning("Could not load persistent state: "
2635
"EOFError:",
2636
exc_info=e)
2221
"EOFError: {0}".format(e))
2637
2222
2638
2223
with PGPEngine() as pgp:
2639
for client_name, client in clients_data.items():
2640
# Skip removed clients
2641
if client_name not in client_settings:
2642
continue
2643
2224
for client_name, client in clients_data.iteritems():
2644
2225
# Decide which value to use after restoring saved state.
2645
2226
# We have three different values: Old config file,
2646
2227
# new config file, and saved state.
2651
2232
# For each value in new config, check if it
2652
2233
# differs from the old config value (Except for
2653
2234
# the "secret" attribute)
2654
if (name != "secret"
2655
and (value !=
2656
old_client_settings[client_name][name])):
2235
if (name != "secret" and
2236
value != old_client_settings[client_name]
2237
[name]):
2657
2238
client[name] = value
2658
2239
except KeyError:
2659
2240
pass
2660
2241
2661
2242
# Clients who has passed its expire date can still be
2662
# enabled if its last checker was successful. A Client
2663
# whose checker succeeded before we stored its state is
2664
# assumed to have successfully run all checkers during
2665
# 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.
2666
2246
if client["enabled"]:
2667
2247
if datetime.datetime.utcnow() >= client["expires"]:
2668
2248
if not client["last_checked_ok"]:
2669
2249
logger.warning(
2670
"disabling client {} - Client never "
2671
"performed a successful checker".format(
2672
client_name))
2250
"disabling client {0} - Client never "
2251
"performed a successfull checker"
2252
.format(client["name"]))
2673
2253
client["enabled"] = False
2674
2254
elif client["last_checker_status"] != 0:
2675
2255
logger.warning(
2676
"disabling client {} - Client last"
2677
" checker failed with error code"
2678
" {}".format(
2679
client_name,
2680
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"]))
2681
2260
client["enabled"] = False
2682
2261
else:
2683
client["expires"] = (
2684
datetime.datetime.utcnow()
2685
+ client["timeout"])
2686
logger.debug("Last checker succeeded,"
2687
" keeping {} enabled".format(
2688
client_name))
2262
client["expires"] = (datetime.datetime
2263
.utcnow()
2264
+ client["timeout"])
2265
2689
2266
try:
2690
client["secret"] = pgp.decrypt(
2691
client["encrypted_secret"],
2692
client_settings[client_name]["secret"])
2267
client["secret"] = (
2268
pgp.decrypt(client["encrypted_secret"],
2269
client_settings[client_name]
2270
["secret"]))
2693
2271
except PGPError:
2694
2272
# If decryption fails, we use secret from new settings
2695
logger.debug("Failed to decrypt {} old secret".format(
2696
client_name))
2697
client["secret"] = (client_settings[client_name]
2698
["secret"])
2273
logger.debug("Failed to decrypt {0} old secret"
2274
.format(client_name))
2275
client["secret"] = (
2276
client_settings[client_name]["secret"])
2277
2699
2278
2700
2279
# Add/remove clients based on new changes made to config
2701
for client_name in (set(old_client_settings)
2702
- set(client_settings)):
2280
for client_name in set(old_client_settings) - set(client_settings):
2703
2281
del clients_data[client_name]
2704
for client_name in (set(client_settings)
2705
- set(old_client_settings)):
2282
for client_name in set(client_settings) - set(old_client_settings):
2706
2283
clients_data[client_name] = client_settings[client_name]
2707
2708
# Create all client objects
2709
for client_name, client in clients_data.items():
2284
2285
# Create clients all clients
2286
for client_name, client in clients_data.iteritems():
2710
2287
tcp_server.clients[client_name] = client_class(
2711
name = client_name,
2712
settings = client,
2713
server_settings = server_settings)
2288
name = client_name, settings = client)
2714
2289
2715
2290
if not tcp_server.clients:
2716
2291
logger.warning("No clients defined")
2717
2718
if not foreground:
2719
if pidfile is not None:
2720
pid = os.getpid()
2721
try:
2722
with pidfile:
2723
print(pid, file=pidfile)
2724
except IOError:
2725
logger.error("Could not write to file %r with PID %d",
2726
pidfilename, pid)
2727
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
2728
2305
del pidfilename
2306
signal.signal(signal.SIGINT, signal.SIG_IGN)
2729
2307
2730
2308
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2731
2309
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2732
2310
2733
2311
if use_dbus:
2734
2735
@alternate_dbus_interfaces(
2736
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2737
class MandosDBusService(DBusObjectWithProperties):
2312
class MandosDBusService(dbus.service.Object):
2738
2313
"""A D-Bus proxy object"""
2739
2740
2314
def __init__(self):
2741
2315
dbus.service.Object.__init__(self, bus, "/")
2742
2743
2316
_interface = "se.recompile.Mandos"
2744
2317
2745
@dbus_interface_annotations(_interface)
2746
def _foo(self):
2747
return {
2748
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2749
"false" }
2750
2751
2318
@dbus.service.signal(_interface, signature="o")
2752
2319
def ClientAdded(self, objpath):
2753
2320
"D-Bus signal"
2766
2333
@dbus.service.method(_interface, out_signature="ao")
2767
2334
def GetAllClients(self):
2768
2335
"D-Bus method"
2769
return dbus.Array(c.dbus_object_path for c in
2336
return dbus.Array(c.dbus_object_path
2337
for c in
2770
2338
tcp_server.clients.itervalues())
2771
2339
2772
2340
@dbus.service.method(_interface,
2774
2342
def GetAllClientsWithProperties(self):
2775
2343
"D-Bus method"
2776
2344
return dbus.Dictionary(
2777
{ c.dbus_object_path: c.GetAll("")
2778
for c in tcp_server.clients.itervalues() },
2345
((c.dbus_object_path, c.GetAll(""))
2346
for c in tcp_server.clients.itervalues()),
2779
2347
signature="oa{sv}")
2780
2348
2781
2349
@dbus.service.method(_interface, in_signature="o")
2794
2362
2795
2363
del _interface
2796
2364
2797
mandos_dbus_service = MandosDBusService()
2365
class MandosDBusServiceTransitional(MandosDBusService):
2366
__metaclass__ = AlternateDBusNamesMetaclass
2367
mandos_dbus_service = MandosDBusServiceTransitional()
2798
2368
2799
2369
def cleanup():
2800
2370
"Cleanup function; run on exit"
2801
if zeroconf:
2802
service.cleanup()
2371
service.cleanup()
2803
2372
2804
2373
multiprocessing.active_children()
2805
wnull.close()
2806
2374
if not (tcp_server.clients or client_settings):
2807
2375
return
2808
2376
2819
2387
2820
2388
# A list of attributes that can not be pickled
2821
2389
# + secret.
2822
exclude = { "bus", "changedstate", "secret",
2823
"checker", "server_settings" }
2824
for name, typ in inspect.getmembers(dbus.service
2825
.Object):
2390
exclude = set(("bus", "changedstate", "secret",
2391
"checker"))
2392
for name, typ in (inspect.getmembers
2393
(dbus.service.Object)):
2826
2394
exclude.add(name)
2827
2395
2828
2396
client_dict["encrypted_secret"] = (client
2835
2403
del client_settings[client.name]["secret"]
2836
2404
2837
2405
try:
2838
with tempfile.NamedTemporaryFile(
2839
mode='wb',
2840
suffix=".pickle",
2841
prefix='clients-',
2842
dir=os.path.dirname(stored_state_path),
2843
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:
2844
2411
pickle.dump((clients, client_settings), stored_state)
2845
tempname = stored_state.name
2846
2412
os.rename(tempname, stored_state_path)
2847
2413
except (IOError, OSError) as e:
2414
logger.warning("Could not save persistent state: {0}"
2415
.format(e))
2848
2416
if not debug:
2849
2417
try:
2850
2418
os.remove(tempname)
2851
2419
except NameError:
2852
2420
pass
2853
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2854
logger.warning("Could not save persistent state: {}"
2855
.format(os.strerror(e.errno)))
2856
else:
2857
logger.warning("Could not save persistent state:",
2858
exc_info=e)
2859
raise
2421
if e.errno not in set((errno.ENOENT, errno.EACCES,
2422
errno.EEXIST)):
2423
raise e
2860
2424
2861
2425
# Delete all clients, and settings from config
2862
2426
while tcp_server.clients:
2867
2431
client.disable(quiet=True)
2868
2432
if use_dbus:
2869
2433
# Emit D-Bus signal
2870
mandos_dbus_service.ClientRemoved(
2871
client.dbus_object_path, client.name)
2434
mandos_dbus_service.ClientRemoved(client
2435
.dbus_object_path,
2436
client.name)
2872
2437
client_settings.clear()
2873
2438
2874
2439
atexit.register(cleanup)
2885
2450
tcp_server.server_activate()
2886
2451
2887
2452
# Find out what port we got
2888
if zeroconf:
2889
service.port = tcp_server.socket.getsockname()[1]
2453
service.port = tcp_server.socket.getsockname()[1]
2890
2454
if use_ipv6:
2891
2455
logger.info("Now listening on address %r, port %d,"
2892
" flowinfo %d, scope_id %d",
2893
*tcp_server.socket.getsockname())
2456
" flowinfo %d, scope_id %d"
2457
% tcp_server.socket.getsockname())
2894
2458
else: # IPv4
2895
logger.info("Now listening on address %r, port %d",
2896
*tcp_server.socket.getsockname())
2459
logger.info("Now listening on address %r, port %d"
2460
% tcp_server.socket.getsockname())
2897
2461
2898
2462
#service.interface = tcp_server.socket.getsockname()[3]
2899
2463
2900
2464
try:
2901
if zeroconf:
2902
# From the Avahi example code
2903
try:
2904
service.activate()
2905
except dbus.exceptions.DBusException as error:
2906
logger.critical("D-Bus Exception", exc_info=error)
2907
cleanup()
2908
sys.exit(1)
2909
# 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
2910
2473
2911
2474
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2912
2475
lambda *args, **kwargs:
2916
2479
logger.debug("Starting main loop")
2917
2480
main_loop.run()
2918
2481
except AvahiError as error:
2919
logger.critical("Avahi Error", exc_info=error)
2482
logger.critical("AvahiError: %s", error)
2920
2483
cleanup()
2921
2484
sys.exit(1)
2922
2485
except KeyboardInterrupt:
2927
2490
# Must run before the D-Bus bus name gets deregistered
2928
2491
cleanup()
2929
2492
2930
2931
2493
if __name__ == '__main__':
2932
2494
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0