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