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