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