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