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