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 237.4.84
- compare with another revision
- download diff
- download tarball
- view history from revision 237.4.84
- Committer: Teddy Hogeborn
- Date: 2016-10-05 20:13:01 UTC
- mto: This revision was merged to the branch mainline in revision 878.
- Revision ID: teddy@recompile.se-20161005201301-3ibock2agjb2ppe6
Tags: version-1.7.12-1
* Makefile (version): Change to 1.7.12.
* NEWS (Version 1.7.12): Add new entry.
* debian/changelog (1.7.12-1): - '' -
* NEWS (Version 1.7.12): Add new entry.
* debian/changelog (1.7.12-1): - '' -
- files added:
- bugs.xml
- debian/upstream
- network-hooks.d
- plugin-helpers
- files modified:
- .bzrignore
added
removed
mandos
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
#
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
#
5
#
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
12
#
12
#
13
13
# Everything else is
14
# Copyright © 2008-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 Björn Påhlsson
16
#
14
# Copyright © 2008-2016 Teddy Hogeborn
15
# Copyright © 2008-2016 Björn Påhlsson
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
19
19
# the Free Software Foundation, either version 3 of the License, or
23
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
24
24
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25
25
# GNU General Public License for more details.
26
#
26
#
27
27
# You should have received a copy of the GNU General Public License
28
28
# along with this program. If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
#
30
#
31
31
# Contact the authors at <mandos@recompile.se>.
32
#
32
#
33
33
34
34
from __future__ import (division, absolute_import, print_function,
35
35
unicode_literals)
36
36
37
import SocketServer as socketserver
37
try:
38
from future_builtins import *
39
except ImportError:
40
pass
41
42
try:
43
import SocketServer as socketserver
44
except ImportError:
45
import socketserver
38
46
import socket
39
47
import argparse
40
48
import datetime
41
49
import errno
42
import gnutls.crypto
43
import gnutls.connection
44
import gnutls.errors
45
import gnutls.library.functions
46
import gnutls.library.constants
47
import gnutls.library.types
48
import ConfigParser as configparser
50
try:
51
import ConfigParser as configparser
52
except ImportError:
53
import configparser
49
54
import sys
50
55
import re
51
56
import os
60
65
import struct
61
66
import fcntl
62
67
import functools
63
import cPickle as pickle
68
try:
69
import cPickle as pickle
70
except ImportError:
71
import pickle
64
72
import multiprocessing
65
73
import types
74
import binascii
75
import tempfile
76
import itertools
77
import collections
78
import codecs
66
79
67
80
import dbus
68
81
import dbus.service
69
import gobject
70
import avahi
82
from gi.repository import GLib
71
83
from dbus.mainloop.glib import DBusGMainLoop
72
84
import ctypes
73
85
import ctypes.util
74
86
import xml.dom.minidom
75
87
import inspect
76
88
89
# Try to find the value of SO_BINDTODEVICE:
77
90
try:
91
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
92
# newer, and it is also the most natural place for it:
78
93
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
79
94
except AttributeError:
80
95
try:
96
# This is where SO_BINDTODEVICE was up to and including Python
97
# 2.6, and also 3.2:
81
98
from IN import SO_BINDTODEVICE
82
99
except ImportError:
83
SO_BINDTODEVICE = None
84
85
86
version = "1.4.0"
87
88
#logger = logging.getLogger('mandos')
89
logger = logging.Logger('mandos')
90
syslogger = (logging.handlers.SysLogHandler
91
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
address = str("/dev/log")))
93
syslogger.setFormatter(logging.Formatter
94
('Mandos [%(process)d]: %(levelname)s:'
95
' %(message)s'))
96
logger.addHandler(syslogger)
97
98
console = logging.StreamHandler()
99
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
100
' %(levelname)s:'
101
' %(message)s'))
102
logger.addHandler(console)
100
# In Python 2.7 it seems to have been removed entirely.
101
# Try running the C preprocessor:
102
try:
103
cc = subprocess.Popen(["cc", "--language=c", "-E",
104
"/dev/stdin"],
105
stdin=subprocess.PIPE,
106
stdout=subprocess.PIPE)
107
stdout = cc.communicate(
108
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
109
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
110
except (OSError, ValueError, IndexError):
111
# No value found
112
SO_BINDTODEVICE = None
113
114
if sys.version_info.major == 2:
115
str = unicode
116
117
version = "1.7.12"
118
stored_state_file = "clients.pickle"
119
120
logger = logging.getLogger()
121
syslogger = None
122
123
try:
124
if_nametoindex = ctypes.cdll.LoadLibrary(
125
ctypes.util.find_library("c")).if_nametoindex
126
except (OSError, AttributeError):
127
128
def if_nametoindex(interface):
129
"Get an interface index the hard way, i.e. using fcntl()"
130
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
131
with contextlib.closing(socket.socket()) as s:
132
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
133
struct.pack(b"16s16x", interface))
134
interface_index = struct.unpack("I", ifreq[16:20])[0]
135
return interface_index
136
137
138
def copy_function(func):
139
"""Make a copy of a function"""
140
if sys.version_info.major == 2:
141
return types.FunctionType(func.func_code,
142
func.func_globals,
143
func.func_name,
144
func.func_defaults,
145
func.func_closure)
146
else:
147
return types.FunctionType(func.__code__,
148
func.__globals__,
149
func.__name__,
150
func.__defaults__,
151
func.__closure__)
152
153
154
def initlogger(debug, level=logging.WARNING):
155
"""init logger and add loglevel"""
156
157
global syslogger
158
syslogger = (logging.handlers.SysLogHandler(
159
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
160
address="/dev/log"))
161
syslogger.setFormatter(logging.Formatter
162
('Mandos [%(process)d]: %(levelname)s:'
163
' %(message)s'))
164
logger.addHandler(syslogger)
165
166
if debug:
167
console = logging.StreamHandler()
168
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
169
' [%(process)d]:'
170
' %(levelname)s:'
171
' %(message)s'))
172
logger.addHandler(console)
173
logger.setLevel(level)
174
175
176
class PGPError(Exception):
177
"""Exception if encryption/decryption fails"""
178
pass
179
180
181
class PGPEngine(object):
182
"""A simple class for OpenPGP symmetric encryption & decryption"""
183
184
def __init__(self):
185
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
186
self.gpg = "gpg"
187
try:
188
output = subprocess.check_output(["gpgconf"])
189
for line in output.splitlines():
190
name, text, path = line.split(b":")
191
if name == "gpg":
192
self.gpg = path
193
break
194
except OSError as e:
195
if e.errno != errno.ENOENT:
196
raise
197
self.gnupgargs = ['--batch',
198
'--homedir', self.tempdir,
199
'--force-mdc',
200
'--quiet']
201
# Only GPG version 1 has the --no-use-agent option.
202
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
203
self.gnupgargs.append("--no-use-agent")
204
205
def __enter__(self):
206
return self
207
208
def __exit__(self, exc_type, exc_value, traceback):
209
self._cleanup()
210
return False
211
212
def __del__(self):
213
self._cleanup()
214
215
def _cleanup(self):
216
if self.tempdir is not None:
217
# Delete contents of tempdir
218
for root, dirs, files in os.walk(self.tempdir,
219
topdown=False):
220
for filename in files:
221
os.remove(os.path.join(root, filename))
222
for dirname in dirs:
223
os.rmdir(os.path.join(root, dirname))
224
# Remove tempdir
225
os.rmdir(self.tempdir)
226
self.tempdir = None
227
228
def password_encode(self, password):
229
# Passphrase can not be empty and can not contain newlines or
230
# NUL bytes. So we prefix it and hex encode it.
231
encoded = b"mandos" + binascii.hexlify(password)
232
if len(encoded) > 2048:
233
# GnuPG can't handle long passwords, so encode differently
234
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
235
.replace(b"\n", b"\\n")
236
.replace(b"\0", b"\\x00"))
237
return encoded
238
239
def encrypt(self, data, password):
240
passphrase = self.password_encode(password)
241
with tempfile.NamedTemporaryFile(
242
dir=self.tempdir) as passfile:
243
passfile.write(passphrase)
244
passfile.flush()
245
proc = subprocess.Popen([self.gpg, '--symmetric',
246
'--passphrase-file',
247
passfile.name]
248
+ self.gnupgargs,
249
stdin=subprocess.PIPE,
250
stdout=subprocess.PIPE,
251
stderr=subprocess.PIPE)
252
ciphertext, err = proc.communicate(input=data)
253
if proc.returncode != 0:
254
raise PGPError(err)
255
return ciphertext
256
257
def decrypt(self, data, password):
258
passphrase = self.password_encode(password)
259
with tempfile.NamedTemporaryFile(
260
dir=self.tempdir) as passfile:
261
passfile.write(passphrase)
262
passfile.flush()
263
proc = subprocess.Popen([self.gpg, '--decrypt',
264
'--passphrase-file',
265
passfile.name]
266
+ self.gnupgargs,
267
stdin=subprocess.PIPE,
268
stdout=subprocess.PIPE,
269
stderr=subprocess.PIPE)
270
decrypted_plaintext, err = proc.communicate(input=data)
271
if proc.returncode != 0:
272
raise PGPError(err)
273
return decrypted_plaintext
274
275
276
# Pretend that we have an Avahi module
277
class Avahi(object):
278
"""This isn't so much a class as it is a module-like namespace.
279
It is instantiated once, and simulates having an Avahi module."""
280
IF_UNSPEC = -1 # avahi-common/address.h
281
PROTO_UNSPEC = -1 # avahi-common/address.h
282
PROTO_INET = 0 # avahi-common/address.h
283
PROTO_INET6 = 1 # avahi-common/address.h
284
DBUS_NAME = "org.freedesktop.Avahi"
285
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
286
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
287
DBUS_PATH_SERVER = "/"
288
289
def string_array_to_txt_array(self, t):
290
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
291
for s in t), signature="ay")
292
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
293
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
294
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
295
SERVER_INVALID = 0 # avahi-common/defs.h
296
SERVER_REGISTERING = 1 # avahi-common/defs.h
297
SERVER_RUNNING = 2 # avahi-common/defs.h
298
SERVER_COLLISION = 3 # avahi-common/defs.h
299
SERVER_FAILURE = 4 # avahi-common/defs.h
300
avahi = Avahi()
301
103
302
104
303
class AvahiError(Exception):
105
304
def __init__(self, value, *args, **kwargs):
106
305
self.value = value
107
super(AvahiError, self).__init__(value, *args, **kwargs)
108
def __unicode__(self):
109
return unicode(repr(self.value))
306
return super(AvahiError, self).__init__(value, *args,
307
**kwargs)
308
110
309
111
310
class AvahiServiceError(AvahiError):
112
311
pass
113
312
313
114
314
class AvahiGroupError(AvahiError):
115
315
pass
116
316
117
317
118
318
class AvahiService(object):
119
319
"""An Avahi (Zeroconf) service.
120
320
121
321
Attributes:
122
322
interface: integer; avahi.IF_UNSPEC or an interface index.
123
323
Used to optionally bind to the specified interface.
124
324
name: string; Example: 'Mandos'
125
325
type: string; Example: '_mandos._tcp'.
126
See <http://www.dns-sd.org/ServiceTypes.html>
326
See <https://www.iana.org/assignments/service-names-port-numbers>
127
327
port: integer; what port to announce
128
328
TXT: list of strings; TXT record for the service
129
329
domain: string; Domain to publish on, default to .local if empty.
135
335
server: D-Bus Server
136
336
bus: dbus.SystemBus()
137
337
"""
138
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
139
servicetype = None, port = None, TXT = None,
140
domain = "", host = "", max_renames = 32768,
141
protocol = avahi.PROTO_UNSPEC, bus = None):
338
339
def __init__(self,
340
interface=avahi.IF_UNSPEC,
341
name=None,
342
servicetype=None,
343
port=None,
344
TXT=None,
345
domain="",
346
host="",
347
max_renames=32768,
348
protocol=avahi.PROTO_UNSPEC,
349
bus=None):
142
350
self.interface = interface
143
351
self.name = name
144
352
self.type = servicetype
153
361
self.server = None
154
362
self.bus = bus
155
363
self.entry_group_state_changed_match = None
156
def rename(self):
364
365
def rename(self, remove=True):
157
366
"""Derived from the Avahi example code"""
158
367
if self.rename_count >= self.max_renames:
159
368
logger.critical("No suitable Zeroconf service name found"
160
369
" after %i retries, exiting.",
161
370
self.rename_count)
162
371
raise AvahiServiceError("Too many renames")
163
self.name = unicode(self.server
164
.GetAlternativeServiceName(self.name))
372
self.name = str(
373
self.server.GetAlternativeServiceName(self.name))
374
self.rename_count += 1
165
375
logger.info("Changing Zeroconf service name to %r ...",
166
376
self.name)
167
syslogger.setFormatter(logging.Formatter
168
('Mandos (%s) [%%(process)d]:'
169
' %%(levelname)s: %%(message)s'
170
% self.name))
171
self.remove()
377
if remove:
378
self.remove()
172
379
try:
173
380
self.add()
174
381
except dbus.exceptions.DBusException as error:
175
logger.critical("DBusException: %s", error)
176
self.cleanup()
177
os._exit(1)
178
self.rename_count += 1
382
if (error.get_dbus_name()
383
== "org.freedesktop.Avahi.CollisionError"):
384
logger.info("Local Zeroconf service name collision.")
385
return self.rename(remove=False)
386
else:
387
logger.critical("D-Bus Exception", exc_info=error)
388
self.cleanup()
389
os._exit(1)
390
179
391
def remove(self):
180
392
"""Derived from the Avahi example code"""
181
393
if self.entry_group_state_changed_match is not None:
183
395
self.entry_group_state_changed_match = None
184
396
if self.group is not None:
185
397
self.group.Reset()
398
186
399
def add(self):
187
400
"""Derived from the Avahi example code"""
188
401
self.remove()
193
406
avahi.DBUS_INTERFACE_ENTRY_GROUP)
194
407
self.entry_group_state_changed_match = (
195
408
self.group.connect_to_signal(
196
'StateChanged', self .entry_group_state_changed))
409
'StateChanged', self.entry_group_state_changed))
197
410
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
198
411
self.name, self.type)
199
412
self.group.AddService(
205
418
dbus.UInt16(self.port),
206
419
avahi.string_array_to_txt_array(self.TXT))
207
420
self.group.Commit()
421
208
422
def entry_group_state_changed(self, state, error):
209
423
"""Derived from the Avahi example code"""
210
424
logger.debug("Avahi entry group state change: %i", state)
211
425
212
426
if state == avahi.ENTRY_GROUP_ESTABLISHED:
213
427
logger.debug("Zeroconf service established.")
214
428
elif state == avahi.ENTRY_GROUP_COLLISION:
216
430
self.rename()
217
431
elif state == avahi.ENTRY_GROUP_FAILURE:
218
432
logger.critical("Avahi: Error in group state changed %s",
219
unicode(error))
220
raise AvahiGroupError("State changed: %s"
221
% unicode(error))
433
str(error))
434
raise AvahiGroupError("State changed: {!s}".format(error))
435
222
436
def cleanup(self):
223
437
"""Derived from the Avahi example code"""
224
438
if self.group is not None:
225
439
try:
226
440
self.group.Free()
227
441
except (dbus.exceptions.UnknownMethodException,
228
dbus.exceptions.DBusException) as e:
442
dbus.exceptions.DBusException):
229
443
pass
230
444
self.group = None
231
445
self.remove()
446
232
447
def server_state_changed(self, state, error=None):
233
448
"""Derived from the Avahi example code"""
234
449
logger.debug("Avahi server state change: %i", state)
235
bad_states = { avahi.SERVER_INVALID:
236
"Zeroconf server invalid",
237
avahi.SERVER_REGISTERING: None,
238
avahi.SERVER_COLLISION:
239
"Zeroconf server name collision",
240
avahi.SERVER_FAILURE:
241
"Zeroconf server failure" }
450
bad_states = {
451
avahi.SERVER_INVALID: "Zeroconf server invalid",
452
avahi.SERVER_REGISTERING: None,
453
avahi.SERVER_COLLISION: "Zeroconf server name collision",
454
avahi.SERVER_FAILURE: "Zeroconf server failure",
455
}
242
456
if state in bad_states:
243
457
if bad_states[state] is not None:
244
458
if error is None:
247
461
logger.error(bad_states[state] + ": %r", error)
248
462
self.cleanup()
249
463
elif state == avahi.SERVER_RUNNING:
250
self.add()
464
try:
465
self.add()
466
except dbus.exceptions.DBusException as error:
467
if (error.get_dbus_name()
468
== "org.freedesktop.Avahi.CollisionError"):
469
logger.info("Local Zeroconf service name"
470
" collision.")
471
return self.rename(remove=False)
472
else:
473
logger.critical("D-Bus Exception", exc_info=error)
474
self.cleanup()
475
os._exit(1)
251
476
else:
252
477
if error is None:
253
478
logger.debug("Unknown state: %r", state)
254
479
else:
255
480
logger.debug("Unknown state: %r: %r", state, error)
481
256
482
def activate(self):
257
483
"""Derived from the Avahi example code"""
258
484
if self.server is None:
262
488
follow_name_owner_changes=True),
263
489
avahi.DBUS_INTERFACE_SERVER)
264
490
self.server.connect_to_signal("StateChanged",
265
self.server_state_changed)
491
self.server_state_changed)
266
492
self.server_state_changed(self.server.GetState())
267
493
268
494
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
274
495
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
497
"""Add the new name to the syslog messages"""
498
ret = AvahiService.rename(self, *args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
501
.format(self.name)))
502
return ret
503
504
505
# Pretend that we have a GnuTLS module
506
class GnuTLS(object):
507
"""This isn't so much a class as it is a module-like namespace.
508
It is instantiated once, and simulates having a GnuTLS module."""
509
510
library = ctypes.util.find_library("gnutls")
511
if library is None:
512
library = ctypes.util.find_library("gnutls-deb0")
513
_library = ctypes.cdll.LoadLibrary(library)
514
del library
515
_need_version = b"3.3.0"
516
517
def __init__(self):
518
# Need to use class name "GnuTLS" here, since this method is
519
# called before the assignment to the "gnutls" global variable
520
# happens.
521
if GnuTLS.check_version(self._need_version) is None:
522
raise GnuTLS.Error("Needs GnuTLS {} or later"
523
.format(self._need_version))
524
525
# Unless otherwise indicated, the constants and types below are
526
# all from the gnutls/gnutls.h C header file.
527
528
# Constants
529
E_SUCCESS = 0
530
E_INTERRUPTED = -52
531
E_AGAIN = -28
532
CRT_OPENPGP = 2
533
CLIENT = 2
534
SHUT_RDWR = 0
535
CRD_CERTIFICATE = 1
536
E_NO_CERTIFICATE_FOUND = -49
537
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
538
539
# Types
540
class session_int(ctypes.Structure):
541
_fields_ = []
542
session_t = ctypes.POINTER(session_int)
543
544
class certificate_credentials_st(ctypes.Structure):
545
_fields_ = []
546
certificate_credentials_t = ctypes.POINTER(
547
certificate_credentials_st)
548
certificate_type_t = ctypes.c_int
549
550
class datum_t(ctypes.Structure):
551
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
('size', ctypes.c_uint)]
553
554
class openpgp_crt_int(ctypes.Structure):
555
_fields_ = []
556
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
557
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
558
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
credentials_type_t = ctypes.c_int
560
transport_ptr_t = ctypes.c_void_p
561
close_request_t = ctypes.c_int
562
563
# Exceptions
564
class Error(Exception):
565
# We need to use the class name "GnuTLS" here, since this
566
# exception might be raised from within GnuTLS.__init__,
567
# which is called before the assignment to the "gnutls"
568
# global variable has happened.
569
def __init__(self, message=None, code=None, args=()):
570
# Default usage is by a message string, but if a return
571
# code is passed, convert it to a string with
572
# gnutls.strerror()
573
self.code = code
574
if message is None and code is not None:
575
message = GnuTLS.strerror(code)
576
return super(GnuTLS.Error, self).__init__(
577
message, *args)
578
579
class CertificateSecurityError(Error):
580
pass
581
582
# Classes
583
class Credentials(object):
584
def __init__(self):
585
self._c_object = gnutls.certificate_credentials_t()
586
gnutls.certificate_allocate_credentials(
587
ctypes.byref(self._c_object))
588
self.type = gnutls.CRD_CERTIFICATE
589
590
def __del__(self):
591
gnutls.certificate_free_credentials(self._c_object)
592
593
class ClientSession(object):
594
def __init__(self, socket, credentials=None):
595
self._c_object = gnutls.session_t()
596
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
597
gnutls.set_default_priority(self._c_object)
598
gnutls.transport_set_ptr(self._c_object, socket.fileno())
599
gnutls.handshake_set_private_extensions(self._c_object,
600
True)
601
self.socket = socket
602
if credentials is None:
603
credentials = gnutls.Credentials()
604
gnutls.credentials_set(self._c_object, credentials.type,
605
ctypes.cast(credentials._c_object,
606
ctypes.c_void_p))
607
self.credentials = credentials
608
609
def __del__(self):
610
gnutls.deinit(self._c_object)
611
612
def handshake(self):
613
return gnutls.handshake(self._c_object)
614
615
def send(self, data):
616
data = bytes(data)
617
data_len = len(data)
618
while data_len > 0:
619
data_len -= gnutls.record_send(self._c_object,
620
data[-data_len:],
621
data_len)
622
623
def bye(self):
624
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
625
626
# Error handling functions
627
def _error_code(result):
628
"""A function to raise exceptions on errors, suitable
629
for the 'restype' attribute on ctypes functions"""
630
if result >= 0:
631
return result
632
if result == gnutls.E_NO_CERTIFICATE_FOUND:
633
raise gnutls.CertificateSecurityError(code=result)
634
raise gnutls.Error(code=result)
635
636
def _retry_on_error(result, func, arguments):
637
"""A function to retry on some errors, suitable
638
for the 'errcheck' attribute on ctypes functions"""
639
while result < 0:
640
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
641
return _error_code(result)
642
result = func(*arguments)
643
return result
644
645
# Unless otherwise indicated, the function declarations below are
646
# all from the gnutls/gnutls.h C header file.
647
648
# Functions
649
priority_set_direct = _library.gnutls_priority_set_direct
650
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
651
ctypes.POINTER(ctypes.c_char_p)]
652
priority_set_direct.restype = _error_code
653
654
init = _library.gnutls_init
655
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
656
init.restype = _error_code
657
658
set_default_priority = _library.gnutls_set_default_priority
659
set_default_priority.argtypes = [session_t]
660
set_default_priority.restype = _error_code
661
662
record_send = _library.gnutls_record_send
663
record_send.argtypes = [session_t, ctypes.c_void_p,
664
ctypes.c_size_t]
665
record_send.restype = ctypes.c_ssize_t
666
record_send.errcheck = _retry_on_error
667
668
certificate_allocate_credentials = (
669
_library.gnutls_certificate_allocate_credentials)
670
certificate_allocate_credentials.argtypes = [
671
ctypes.POINTER(certificate_credentials_t)]
672
certificate_allocate_credentials.restype = _error_code
673
674
certificate_free_credentials = (
675
_library.gnutls_certificate_free_credentials)
676
certificate_free_credentials.argtypes = [
677
certificate_credentials_t]
678
certificate_free_credentials.restype = None
679
680
handshake_set_private_extensions = (
681
_library.gnutls_handshake_set_private_extensions)
682
handshake_set_private_extensions.argtypes = [session_t,
683
ctypes.c_int]
684
handshake_set_private_extensions.restype = None
685
686
credentials_set = _library.gnutls_credentials_set
687
credentials_set.argtypes = [session_t, credentials_type_t,
688
ctypes.c_void_p]
689
credentials_set.restype = _error_code
690
691
strerror = _library.gnutls_strerror
692
strerror.argtypes = [ctypes.c_int]
693
strerror.restype = ctypes.c_char_p
694
695
certificate_type_get = _library.gnutls_certificate_type_get
696
certificate_type_get.argtypes = [session_t]
697
certificate_type_get.restype = _error_code
698
699
certificate_get_peers = _library.gnutls_certificate_get_peers
700
certificate_get_peers.argtypes = [session_t,
701
ctypes.POINTER(ctypes.c_uint)]
702
certificate_get_peers.restype = ctypes.POINTER(datum_t)
703
704
global_set_log_level = _library.gnutls_global_set_log_level
705
global_set_log_level.argtypes = [ctypes.c_int]
706
global_set_log_level.restype = None
707
708
global_set_log_function = _library.gnutls_global_set_log_function
709
global_set_log_function.argtypes = [log_func]
710
global_set_log_function.restype = None
711
712
deinit = _library.gnutls_deinit
713
deinit.argtypes = [session_t]
714
deinit.restype = None
715
716
handshake = _library.gnutls_handshake
717
handshake.argtypes = [session_t]
718
handshake.restype = _error_code
719
handshake.errcheck = _retry_on_error
720
721
transport_set_ptr = _library.gnutls_transport_set_ptr
722
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
723
transport_set_ptr.restype = None
724
725
bye = _library.gnutls_bye
726
bye.argtypes = [session_t, close_request_t]
727
bye.restype = _error_code
728
bye.errcheck = _retry_on_error
729
730
check_version = _library.gnutls_check_version
731
check_version.argtypes = [ctypes.c_char_p]
732
check_version.restype = ctypes.c_char_p
733
734
# All the function declarations below are from gnutls/openpgp.h
735
736
openpgp_crt_init = _library.gnutls_openpgp_crt_init
737
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
738
openpgp_crt_init.restype = _error_code
739
740
openpgp_crt_import = _library.gnutls_openpgp_crt_import
741
openpgp_crt_import.argtypes = [openpgp_crt_t,
742
ctypes.POINTER(datum_t),
743
openpgp_crt_fmt_t]
744
openpgp_crt_import.restype = _error_code
745
746
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
747
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
748
ctypes.POINTER(ctypes.c_uint)]
749
openpgp_crt_verify_self.restype = _error_code
750
751
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
752
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
753
openpgp_crt_deinit.restype = None
754
755
openpgp_crt_get_fingerprint = (
756
_library.gnutls_openpgp_crt_get_fingerprint)
757
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
758
ctypes.c_void_p,
759
ctypes.POINTER(
760
ctypes.c_size_t)]
761
openpgp_crt_get_fingerprint.restype = _error_code
762
763
# Remove non-public functions
764
del _error_code, _retry_on_error
765
# Create the global "gnutls" object, simulating a module
766
gnutls = GnuTLS()
767
768
769
def call_pipe(connection, # : multiprocessing.Connection
770
func, *args, **kwargs):
771
"""This function is meant to be called by multiprocessing.Process
772
773
This function runs func(*args, **kwargs), and writes the resulting
774
return value on the provided multiprocessing.Connection.
775
"""
776
connection.send(func(*args, **kwargs))
777
connection.close()
778
779
275
780
class Client(object):
276
781
"""A representation of a client host served by this server.
277
782
278
783
Attributes:
279
_approved: bool(); 'None' if not yet approved/disapproved
784
approved: bool(); 'None' if not yet approved/disapproved
280
785
approval_delay: datetime.timedelta(); Time to wait for approval
281
786
approval_duration: datetime.timedelta(); Duration of one approval
282
787
checker: subprocess.Popen(); a running checker process used
283
788
to see if the client lives.
284
789
'None' if no process is running.
285
checker_callback_tag: a gobject event source tag, or None
790
checker_callback_tag: a GLib event source tag, or None
286
791
checker_command: string; External command which is run to check
287
792
if client lives. %() expansions are done at
288
793
runtime with vars(self) as dict, so that for
289
794
instance %(name)s can be used in the command.
290
checker_initiator_tag: a gobject event source tag, or None
795
checker_initiator_tag: a GLib event source tag, or None
291
796
created: datetime.datetime(); (UTC) object creation
797
client_structure: Object describing what attributes a client has
798
and is used for storing the client at exit
292
799
current_checker_command: string; current running checker_command
293
disable_hook: If set, called by disable() as disable_hook(self)
294
disable_initiator_tag: a gobject event source tag, or None
800
disable_initiator_tag: a GLib event source tag, or None
295
801
enabled: bool()
296
802
fingerprint: string (40 or 32 hexadecimal digits); used to
297
803
uniquely identify the client
299
805
interval: datetime.timedelta(); How often to start a new checker
300
806
last_approval_request: datetime.datetime(); (UTC) or None
301
807
last_checked_ok: datetime.datetime(); (UTC) or None
302
last_enabled: datetime.datetime(); (UTC)
808
last_checker_status: integer between 0 and 255 reflecting exit
809
status of last checker. -1 reflects crashed
810
checker, -2 means no checker completed yet.
811
last_checker_signal: The signal which killed the last checker, if
812
last_checker_status is -1
813
last_enabled: datetime.datetime(); (UTC) or None
303
814
name: string; from the config file, used in log messages and
304
815
D-Bus identifiers
305
816
secret: bytestring; sent verbatim (over TLS) to client
306
817
timeout: datetime.timedelta(); How long from last_checked_ok
307
818
until this client is disabled
308
extended_timeout: extra long timeout when password has been sent
819
extended_timeout: extra long timeout when secret has been sent
309
820
runtime_expansions: Allowed attributes for runtime expansion.
310
821
expires: datetime.datetime(); time (UTC) when a client will be
311
822
disabled, or None
823
server_settings: The server_settings dict from main()
312
824
"""
313
825
314
826
runtime_expansions = ("approval_delay", "approval_duration",
315
"created", "enabled", "fingerprint",
316
"host", "interval", "last_checked_ok",
827
"created", "enabled", "expires",
828
"fingerprint", "host", "interval",
829
"last_approval_request", "last_checked_ok",
317
830
"last_enabled", "name", "timeout")
318
319
def timeout_milliseconds(self):
320
"Return the 'timeout' attribute in milliseconds"
321
return _timedelta_to_milliseconds(self.timeout)
322
323
def extended_timeout_milliseconds(self):
324
"Return the 'extended_timeout' attribute in milliseconds"
325
return _timedelta_to_milliseconds(self.extended_timeout)
326
327
def interval_milliseconds(self):
328
"Return the 'interval' attribute in milliseconds"
329
return _timedelta_to_milliseconds(self.interval)
330
331
def approval_delay_milliseconds(self):
332
return _timedelta_to_milliseconds(self.approval_delay)
333
334
def __init__(self, name = None, disable_hook=None, config=None):
335
"""Note: the 'checker' key in 'config' sets the
336
'checker_command' attribute and *not* the 'checker'
337
attribute."""
831
client_defaults = {
832
"timeout": "PT5M",
833
"extended_timeout": "PT15M",
834
"interval": "PT2M",
835
"checker": "fping -q -- %%(host)s",
836
"host": "",
837
"approval_delay": "PT0S",
838
"approval_duration": "PT1S",
839
"approved_by_default": "True",
840
"enabled": "True",
841
}
842
843
@staticmethod
844
def config_parser(config):
845
"""Construct a new dict of client settings of this form:
846
{ client_name: {setting_name: value, ...}, ...}
847
with exceptions for any special settings as defined above.
848
NOTE: Must be a pure function. Must return the same result
849
value given the same arguments.
850
"""
851
settings = {}
852
for client_name in config.sections():
853
section = dict(config.items(client_name))
854
client = settings[client_name] = {}
855
856
client["host"] = section["host"]
857
# Reformat values from string types to Python types
858
client["approved_by_default"] = config.getboolean(
859
client_name, "approved_by_default")
860
client["enabled"] = config.getboolean(client_name,
861
"enabled")
862
863
# Uppercase and remove spaces from fingerprint for later
864
# comparison purposes with return value from the
865
# fingerprint() function
866
client["fingerprint"] = (section["fingerprint"].upper()
867
.replace(" ", ""))
868
if "secret" in section:
869
client["secret"] = codecs.decode(section["secret"]
870
.encode("utf-8"),
871
"base64")
872
elif "secfile" in section:
873
with open(os.path.expanduser(os.path.expandvars
874
(section["secfile"])),
875
"rb") as secfile:
876
client["secret"] = secfile.read()
877
else:
878
raise TypeError("No secret or secfile for section {}"
879
.format(section))
880
client["timeout"] = string_to_delta(section["timeout"])
881
client["extended_timeout"] = string_to_delta(
882
section["extended_timeout"])
883
client["interval"] = string_to_delta(section["interval"])
884
client["approval_delay"] = string_to_delta(
885
section["approval_delay"])
886
client["approval_duration"] = string_to_delta(
887
section["approval_duration"])
888
client["checker_command"] = section["checker"]
889
client["last_approval_request"] = None
890
client["last_checked_ok"] = None
891
client["last_checker_status"] = -2
892
893
return settings
894
895
def __init__(self, settings, name=None, server_settings=None):
338
896
self.name = name
339
if config is None:
340
config = {}
897
if server_settings is None:
898
server_settings = {}
899
self.server_settings = server_settings
900
# adding all client settings
901
for setting, value in settings.items():
902
setattr(self, setting, value)
903
904
if self.enabled:
905
if not hasattr(self, "last_enabled"):
906
self.last_enabled = datetime.datetime.utcnow()
907
if not hasattr(self, "expires"):
908
self.expires = (datetime.datetime.utcnow()
909
+ self.timeout)
910
else:
911
self.last_enabled = None
912
self.expires = None
913
341
914
logger.debug("Creating client %r", self.name)
342
# Uppercase and remove spaces from fingerprint for later
343
# comparison purposes with return value from the fingerprint()
344
# function
345
self.fingerprint = (config["fingerprint"].upper()
346
.replace(" ", ""))
347
915
logger.debug(" Fingerprint: %s", self.fingerprint)
348
if "secret" in config:
349
self.secret = config["secret"].decode("base64")
350
elif "secfile" in config:
351
with open(os.path.expanduser(os.path.expandvars
352
(config["secfile"])),
353
"rb") as secfile:
354
self.secret = secfile.read()
355
else:
356
raise TypeError("No secret or secfile for client %s"
357
% self.name)
358
self.host = config.get("host", "")
359
self.created = datetime.datetime.utcnow()
360
self.enabled = False
361
self.last_approval_request = None
362
self.last_enabled = None
363
self.last_checked_ok = None
364
self.timeout = string_to_delta(config["timeout"])
365
self.extended_timeout = string_to_delta(config
366
["extended_timeout"])
367
self.interval = string_to_delta(config["interval"])
368
self.disable_hook = disable_hook
916
self.created = settings.get("created",
917
datetime.datetime.utcnow())
918
919
# attributes specific for this server instance
369
920
self.checker = None
370
921
self.checker_initiator_tag = None
371
922
self.disable_initiator_tag = None
372
self.expires = None
373
923
self.checker_callback_tag = None
374
self.checker_command = config["checker"]
375
924
self.current_checker_command = None
376
self.last_connect = None
377
self._approved = None
378
self.approved_by_default = config.get("approved_by_default",
379
True)
925
self.approved = None
380
926
self.approvals_pending = 0
381
self.approval_delay = string_to_delta(
382
config["approval_delay"])
383
self.approval_duration = string_to_delta(
384
config["approval_duration"])
385
self.changedstate = (multiprocessing_manager
386
.Condition(multiprocessing_manager
387
.Lock()))
388
927
self.changedstate = multiprocessing_manager.Condition(
928
multiprocessing_manager.Lock())
929
self.client_structure = [attr
930
for attr in self.__dict__.keys()
931
if not attr.startswith("_")]
932
self.client_structure.append("client_structure")
933
934
for name, t in inspect.getmembers(
935
type(self), lambda obj: isinstance(obj, property)):
936
if not name.startswith("_"):
937
self.client_structure.append(name)
938
939
# Send notice to process children that client state has changed
389
940
def send_changedstate(self):
390
self.changedstate.acquire()
391
self.changedstate.notify_all()
392
self.changedstate.release()
393
941
with self.changedstate:
942
self.changedstate.notify_all()
943
394
944
def enable(self):
395
945
"""Start this client's checker and timeout hooks"""
396
946
if getattr(self, "enabled", False):
397
947
# Already enabled
398
948
return
399
self.send_changedstate()
400
# Schedule a new checker to be started an 'interval' from now,
401
# and every interval from then on.
402
self.checker_initiator_tag = (gobject.timeout_add
403
(self.interval_milliseconds(),
404
self.start_checker))
405
# Schedule a disable() when 'timeout' has passed
406
949
self.expires = datetime.datetime.utcnow() + self.timeout
407
self.disable_initiator_tag = (gobject.timeout_add
408
(self.timeout_milliseconds(),
409
self.disable))
410
950
self.enabled = True
411
951
self.last_enabled = datetime.datetime.utcnow()
412
# Also start a new checker *right now*.
413
self.start_checker()
414
952
self.init_checker()
953
self.send_changedstate()
954
415
955
def disable(self, quiet=True):
416
956
"""Disable this client."""
417
957
if not getattr(self, "enabled", False):
418
958
return False
419
959
if not quiet:
420
self.send_changedstate()
421
if not quiet:
422
960
logger.info("Disabling client %s", self.name)
423
if getattr(self, "disable_initiator_tag", False):
424
gobject.source_remove(self.disable_initiator_tag)
961
if getattr(self, "disable_initiator_tag", None) is not None:
962
GLib.source_remove(self.disable_initiator_tag)
425
963
self.disable_initiator_tag = None
426
964
self.expires = None
427
if getattr(self, "checker_initiator_tag", False):
428
gobject.source_remove(self.checker_initiator_tag)
965
if getattr(self, "checker_initiator_tag", None) is not None:
966
GLib.source_remove(self.checker_initiator_tag)
429
967
self.checker_initiator_tag = None
430
968
self.stop_checker()
431
if self.disable_hook:
432
self.disable_hook(self)
433
969
self.enabled = False
434
# Do not run this again if called by a gobject.timeout_add
970
if not quiet:
971
self.send_changedstate()
972
# Do not run this again if called by a GLib.timeout_add
435
973
return False
436
974
437
975
def __del__(self):
438
self.disable_hook = None
439
976
self.disable()
440
441
def checker_callback(self, pid, condition, command):
977
978
def init_checker(self):
979
# Schedule a new checker to be started an 'interval' from now,
980
# and every interval from then on.
981
if self.checker_initiator_tag is not None:
982
GLib.source_remove(self.checker_initiator_tag)
983
self.checker_initiator_tag = GLib.timeout_add(
984
int(self.interval.total_seconds() * 1000),
985
self.start_checker)
986
# Schedule a disable() when 'timeout' has passed
987
if self.disable_initiator_tag is not None:
988
GLib.source_remove(self.disable_initiator_tag)
989
self.disable_initiator_tag = GLib.timeout_add(
990
int(self.timeout.total_seconds() * 1000), self.disable)
991
# Also start a new checker *right now*.
992
self.start_checker()
993
994
def checker_callback(self, source, condition, connection,
995
command):
442
996
"""The checker has completed, so take appropriate actions."""
443
997
self.checker_callback_tag = None
444
998
self.checker = None
445
if os.WIFEXITED(condition):
446
exitstatus = os.WEXITSTATUS(condition)
447
if exitstatus == 0:
999
# Read return code from connection (see call_pipe)
1000
returncode = connection.recv()
1001
connection.close()
1002
1003
if returncode >= 0:
1004
self.last_checker_status = returncode
1005
self.last_checker_signal = None
1006
if self.last_checker_status == 0:
448
1007
logger.info("Checker for %(name)s succeeded",
449
1008
vars(self))
450
1009
self.checked_ok()
451
1010
else:
452
logger.info("Checker for %(name)s failed",
453
vars(self))
1011
logger.info("Checker for %(name)s failed", vars(self))
454
1012
else:
1013
self.last_checker_status = -1
1014
self.last_checker_signal = -returncode
455
1015
logger.warning("Checker for %(name)s crashed?",
456
1016
vars(self))
457
458
def checked_ok(self, timeout=None):
459
"""Bump up the timeout for this client.
460
461
This should only be called when the client has been seen,
462
alive and well.
463
"""
1017
return False
1018
1019
def checked_ok(self):
1020
"""Assert that the client has been seen, alive and well."""
1021
self.last_checked_ok = datetime.datetime.utcnow()
1022
self.last_checker_status = 0
1023
self.last_checker_signal = None
1024
self.bump_timeout()
1025
1026
def bump_timeout(self, timeout=None):
1027
"""Bump up the timeout for this client."""
464
1028
if timeout is None:
465
1029
timeout = self.timeout
466
self.last_checked_ok = datetime.datetime.utcnow()
467
gobject.source_remove(self.disable_initiator_tag)
468
self.disable_initiator_tag = (gobject.timeout_add
469
(_timedelta_to_milliseconds
470
(timeout), self.disable))
471
self.expires = datetime.datetime.utcnow() + timeout
472
1030
if self.disable_initiator_tag is not None:
1031
GLib.source_remove(self.disable_initiator_tag)
1032
self.disable_initiator_tag = None
1033
if getattr(self, "enabled", False):
1034
self.disable_initiator_tag = GLib.timeout_add(
1035
int(timeout.total_seconds() * 1000), self.disable)
1036
self.expires = datetime.datetime.utcnow() + timeout
1037
473
1038
def need_approval(self):
474
1039
self.last_approval_request = datetime.datetime.utcnow()
475
1040
476
1041
def start_checker(self):
477
1042
"""Start a new checker subprocess if one is not running.
478
1043
479
1044
If a checker already exists, leave it running and do
480
1045
nothing."""
481
1046
# The reason for not killing a running checker is that if we
482
# did that, then if a checker (for some reason) started
483
# running slowly and taking more than 'interval' time, the
484
# client would inevitably timeout, since no checker would get
485
# a chance to run to completion. If we instead leave running
1047
# did that, and if a checker (for some reason) started running
1048
# slowly and taking more than 'interval' time, then the client
1049
# would inevitably timeout, since no checker would get a
1050
# chance to run to completion. If we instead leave running
486
1051
# checkers alone, the checker would have to take more time
487
1052
# than 'timeout' for the client to be disabled, which is as it
488
1053
# should be.
489
490
# If a checker exists, make sure it is not a zombie
491
try:
492
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
493
except (AttributeError, OSError) as error:
494
if (isinstance(error, OSError)
495
and error.errno != errno.ECHILD):
496
raise error
497
else:
498
if pid:
499
logger.warning("Checker was a zombie")
500
gobject.source_remove(self.checker_callback_tag)
501
self.checker_callback(pid, status,
502
self.current_checker_command)
1054
1055
if self.checker is not None and not self.checker.is_alive():
1056
logger.warning("Checker was not alive; joining")
1057
self.checker.join()
1058
self.checker = None
503
1059
# Start a new checker if needed
504
1060
if self.checker is None:
1061
# Escape attributes for the shell
1062
escaped_attrs = {
1063
attr: re.escape(str(getattr(self, attr)))
1064
for attr in self.runtime_expansions}
505
1065
try:
506
# In case checker_command has exactly one % operator
507
command = self.checker_command % self.host
508
except TypeError:
509
# Escape attributes for the shell
510
escaped_attrs = dict(
511
(attr,
512
re.escape(unicode(str(getattr(self, attr, "")),
513
errors=
514
'replace')))
515
for attr in
516
self.runtime_expansions)
517
518
try:
519
command = self.checker_command % escaped_attrs
520
except TypeError as error:
521
logger.error('Could not format string "%s":'
522
' %s', self.checker_command, error)
523
return True # Try again later
1066
command = self.checker_command % escaped_attrs
1067
except TypeError as error:
1068
logger.error('Could not format string "%s"',
1069
self.checker_command,
1070
exc_info=error)
1071
return True # Try again later
524
1072
self.current_checker_command = command
525
try:
526
logger.info("Starting checker %r for %s",
527
command, self.name)
528
# We don't need to redirect stdout and stderr, since
529
# in normal mode, that is already done by daemon(),
530
# and in debug mode we don't want to. (Stdin is
531
# always replaced by /dev/null.)
532
self.checker = subprocess.Popen(command,
533
close_fds=True,
534
shell=True, cwd="/")
535
self.checker_callback_tag = (gobject.child_watch_add
536
(self.checker.pid,
537
self.checker_callback,
538
data=command))
539
# The checker may have completed before the gobject
540
# watch was added. Check for this.
541
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
542
if pid:
543
gobject.source_remove(self.checker_callback_tag)
544
self.checker_callback(pid, status, command)
545
except OSError as error:
546
logger.error("Failed to start subprocess: %s",
547
error)
548
# Re-run this periodically if run by gobject.timeout_add
1073
logger.info("Starting checker %r for %s", command,
1074
self.name)
1075
# We don't need to redirect stdout and stderr, since
1076
# in normal mode, that is already done by daemon(),
1077
# and in debug mode we don't want to. (Stdin is
1078
# always replaced by /dev/null.)
1079
# The exception is when not debugging but nevertheless
1080
# running in the foreground; use the previously
1081
# created wnull.
1082
popen_args = {"close_fds": True,
1083
"shell": True,
1084
"cwd": "/"}
1085
if (not self.server_settings["debug"]
1086
and self.server_settings["foreground"]):
1087
popen_args.update({"stdout": wnull,
1088
"stderr": wnull})
1089
pipe = multiprocessing.Pipe(duplex=False)
1090
self.checker = multiprocessing.Process(
1091
target=call_pipe,
1092
args=(pipe[1], subprocess.call, command),
1093
kwargs=popen_args)
1094
self.checker.start()
1095
self.checker_callback_tag = GLib.io_add_watch(
1096
pipe[0].fileno(), GLib.IO_IN,
1097
self.checker_callback, pipe[0], command)
1098
# Re-run this periodically if run by GLib.timeout_add
549
1099
return True
550
1100
551
1101
def stop_checker(self):
552
1102
"""Force the checker process, if any, to stop."""
553
1103
if self.checker_callback_tag:
554
gobject.source_remove(self.checker_callback_tag)
1104
GLib.source_remove(self.checker_callback_tag)
555
1105
self.checker_callback_tag = None
556
1106
if getattr(self, "checker", None) is None:
557
1107
return
558
1108
logger.debug("Stopping checker for %(name)s", vars(self))
559
try:
560
os.kill(self.checker.pid, signal.SIGTERM)
561
#time.sleep(0.5)
562
#if self.checker.poll() is None:
563
# os.kill(self.checker.pid, signal.SIGKILL)
564
except OSError as error:
565
if error.errno != errno.ESRCH: # No such process
566
raise
1109
self.checker.terminate()
567
1110
self.checker = None
568
1111
569
1112
570
def dbus_service_property(dbus_interface, signature="v",
571
access="readwrite", byte_arrays=False):
1113
def dbus_service_property(dbus_interface,
1114
signature="v",
1115
access="readwrite",
1116
byte_arrays=False):
572
1117
"""Decorators for marking methods of a DBusObjectWithProperties to
573
1118
become properties on the D-Bus.
574
1119
575
1120
The decorated method will be called with no arguments by "Get"
576
1121
and with one argument by "Set".
577
1122
578
1123
The parameters, where they are supported, are the same as
579
1124
dbus.service.method, except there is only "signature", since the
580
1125
type from Get() and the type sent to Set() is the same.
583
1128
# "Set" method, so we fail early here:
584
1129
if byte_arrays and signature != "ay":
585
1130
raise ValueError("Byte arrays not supported for non-'ay'"
586
" signature %r" % signature)
1131
" signature {!r}".format(signature))
1132
587
1133
def decorator(func):
588
1134
func._dbus_is_property = True
589
1135
func._dbus_interface = dbus_interface
592
1138
func._dbus_name = func.__name__
593
1139
if func._dbus_name.endswith("_dbus_property"):
594
1140
func._dbus_name = func._dbus_name[:-14]
595
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
596
return func
1141
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1142
return func
1143
1144
return decorator
1145
1146
1147
def dbus_interface_annotations(dbus_interface):
1148
"""Decorator for marking functions returning interface annotations
1149
1150
Usage:
1151
1152
@dbus_interface_annotations("org.example.Interface")
1153
def _foo(self): # Function name does not matter
1154
return {"org.freedesktop.DBus.Deprecated": "true",
1155
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1156
"false"}
1157
"""
1158
1159
def decorator(func):
1160
func._dbus_is_interface = True
1161
func._dbus_interface = dbus_interface
1162
func._dbus_name = dbus_interface
1163
return func
1164
1165
return decorator
1166
1167
1168
def dbus_annotations(annotations):
1169
"""Decorator to annotate D-Bus methods, signals or properties
1170
Usage:
1171
1172
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1173
"org.freedesktop.DBus.Property."
1174
"EmitsChangedSignal": "false"})
1175
@dbus_service_property("org.example.Interface", signature="b",
1176
access="r")
1177
def Property_dbus_property(self):
1178
return dbus.Boolean(False)
1179
1180
See also the DBusObjectWithAnnotations class.
1181
"""
1182
1183
def decorator(func):
1184
func._dbus_annotations = annotations
1185
return func
1186
597
1187
return decorator
598
1188
599
1189
600
1190
class DBusPropertyException(dbus.exceptions.DBusException):
601
1191
"""A base class for D-Bus property-related exceptions
602
1192
"""
603
def __unicode__(self):
604
return unicode(str(self))
1193
pass
605
1194
606
1195
607
1196
class DBusPropertyAccessException(DBusPropertyException):
616
1205
pass
617
1206
618
1207
619
class DBusObjectWithProperties(dbus.service.Object):
1208
class DBusObjectWithAnnotations(dbus.service.Object):
1209
"""A D-Bus object with annotations.
1210
1211
Classes inheriting from this can use the dbus_annotations
1212
decorator to add annotations to methods or signals.
1213
"""
1214
1215
@staticmethod
1216
def _is_dbus_thing(thing):
1217
"""Returns a function testing if an attribute is a D-Bus thing
1218
1219
If called like _is_dbus_thing("method") it returns a function
1220
suitable for use as predicate to inspect.getmembers().
1221
"""
1222
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1223
False)
1224
1225
def _get_all_dbus_things(self, thing):
1226
"""Returns a generator of (name, attribute) pairs
1227
"""
1228
return ((getattr(athing.__get__(self), "_dbus_name", name),
1229
athing.__get__(self))
1230
for cls in self.__class__.__mro__
1231
for name, athing in
1232
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1233
1234
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1235
out_signature="s",
1236
path_keyword='object_path',
1237
connection_keyword='connection')
1238
def Introspect(self, object_path, connection):
1239
"""Overloading of standard D-Bus method.
1240
1241
Inserts annotation tags on methods and signals.
1242
"""
1243
xmlstring = dbus.service.Object.Introspect(self, object_path,
1244
connection)
1245
try:
1246
document = xml.dom.minidom.parseString(xmlstring)
1247
1248
for if_tag in document.getElementsByTagName("interface"):
1249
# Add annotation tags
1250
for typ in ("method", "signal"):
1251
for tag in if_tag.getElementsByTagName(typ):
1252
annots = dict()
1253
for name, prop in (self.
1254
_get_all_dbus_things(typ)):
1255
if (name == tag.getAttribute("name")
1256
and prop._dbus_interface
1257
== if_tag.getAttribute("name")):
1258
annots.update(getattr(
1259
prop, "_dbus_annotations", {}))
1260
for name, value in annots.items():
1261
ann_tag = document.createElement(
1262
"annotation")
1263
ann_tag.setAttribute("name", name)
1264
ann_tag.setAttribute("value", value)
1265
tag.appendChild(ann_tag)
1266
# Add interface annotation tags
1267
for annotation, value in dict(
1268
itertools.chain.from_iterable(
1269
annotations().items()
1270
for name, annotations
1271
in self._get_all_dbus_things("interface")
1272
if name == if_tag.getAttribute("name")
1273
)).items():
1274
ann_tag = document.createElement("annotation")
1275
ann_tag.setAttribute("name", annotation)
1276
ann_tag.setAttribute("value", value)
1277
if_tag.appendChild(ann_tag)
1278
# Fix argument name for the Introspect method itself
1279
if (if_tag.getAttribute("name")
1280
== dbus.INTROSPECTABLE_IFACE):
1281
for cn in if_tag.getElementsByTagName("method"):
1282
if cn.getAttribute("name") == "Introspect":
1283
for arg in cn.getElementsByTagName("arg"):
1284
if (arg.getAttribute("direction")
1285
== "out"):
1286
arg.setAttribute("name",
1287
"xml_data")
1288
xmlstring = document.toxml("utf-8")
1289
document.unlink()
1290
except (AttributeError, xml.dom.DOMException,
1291
xml.parsers.expat.ExpatError) as error:
1292
logger.error("Failed to override Introspection method",
1293
exc_info=error)
1294
return xmlstring
1295
1296
1297
class DBusObjectWithProperties(DBusObjectWithAnnotations):
620
1298
"""A D-Bus object with properties.
621
1299
622
1300
Classes inheriting from this can use the dbus_service_property
623
1301
decorator to expose methods as D-Bus properties. It exposes the
624
1302
standard Get(), Set(), and GetAll() methods on the D-Bus.
625
1303
"""
626
627
@staticmethod
628
def _is_dbus_property(obj):
629
return getattr(obj, "_dbus_is_property", False)
630
631
def _get_all_dbus_properties(self):
632
"""Returns a generator of (name, attribute) pairs
633
"""
634
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
635
for cls in self.__class__.__mro__
636
for name, prop in
637
inspect.getmembers(cls, self._is_dbus_property))
638
1304
639
1305
def _get_dbus_property(self, interface_name, property_name):
640
1306
"""Returns a bound method if one exists which is a D-Bus
641
1307
property with the specified name and interface.
642
1308
"""
643
for cls in self.__class__.__mro__:
644
for name, value in (inspect.getmembers
645
(cls, self._is_dbus_property)):
1309
for cls in self.__class__.__mro__:
1310
for name, value in inspect.getmembers(
1311
cls, self._is_dbus_thing("property")):
646
1312
if (value._dbus_name == property_name
647
1313
and value._dbus_interface == interface_name):
648
1314
return value.__get__(self)
649
1315
650
1316
# No such property
651
raise DBusPropertyNotFound(self.dbus_object_path + ":"
652
+ interface_name + "."
653
+ property_name)
654
655
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1317
raise DBusPropertyNotFound("{}:{}.{}".format(
1318
self.dbus_object_path, interface_name, property_name))
1319
1320
@classmethod
1321
def _get_all_interface_names(cls):
1322
"""Get a sequence of all interfaces supported by an object"""
1323
return (name for name in set(getattr(getattr(x, attr),
1324
"_dbus_interface", None)
1325
for x in (inspect.getmro(cls))
1326
for attr in dir(x))
1327
if name is not None)
1328
1329
@dbus.service.method(dbus.PROPERTIES_IFACE,
1330
in_signature="ss",
656
1331
out_signature="v")
657
1332
def Get(self, interface_name, property_name):
658
1333
"""Standard D-Bus property Get() method, see D-Bus standard.
664
1339
if not hasattr(value, "variant_level"):
665
1340
return value
666
1341
return type(value)(value, variant_level=value.variant_level+1)
667
1342
668
1343
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
669
1344
def Set(self, interface_name, property_name, value):
670
1345
"""Standard D-Bus property Set() method, see D-Bus standard.
676
1351
# The byte_arrays option is not supported yet on
677
1352
# signatures other than "ay".
678
1353
if prop._dbus_signature != "ay":
679
raise ValueError
680
value = dbus.ByteArray(''.join(unichr(byte)
681
for byte in value))
1354
raise ValueError("Byte arrays not supported for non-"
1355
"'ay' signature {!r}"
1356
.format(prop._dbus_signature))
1357
value = dbus.ByteArray(b''.join(chr(byte)
1358
for byte in value))
682
1359
prop(value)
683
684
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1360
1361
@dbus.service.method(dbus.PROPERTIES_IFACE,
1362
in_signature="s",
685
1363
out_signature="a{sv}")
686
1364
def GetAll(self, interface_name):
687
1365
"""Standard D-Bus property GetAll() method, see D-Bus
688
1366
standard.
689
1367
690
1368
Note: Will not include properties with access="write".
691
1369
"""
692
all = {}
693
for name, prop in self._get_all_dbus_properties():
1370
properties = {}
1371
for name, prop in self._get_all_dbus_things("property"):
694
1372
if (interface_name
695
1373
and interface_name != prop._dbus_interface):
696
1374
# Interface non-empty but did not match
700
1378
continue
701
1379
value = prop()
702
1380
if not hasattr(value, "variant_level"):
703
all[name] = value
1381
properties[name] = value
704
1382
continue
705
all[name] = type(value)(value, variant_level=
706
value.variant_level+1)
707
return dbus.Dictionary(all, signature="sv")
708
1383
properties[name] = type(value)(
1384
value, variant_level=value.variant_level + 1)
1385
return dbus.Dictionary(properties, signature="sv")
1386
1387
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1388
def PropertiesChanged(self, interface_name, changed_properties,
1389
invalidated_properties):
1390
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1391
standard.
1392
"""
1393
pass
1394
709
1395
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
710
1396
out_signature="s",
711
1397
path_keyword='object_path',
712
1398
connection_keyword='connection')
713
1399
def Introspect(self, object_path, connection):
714
"""Standard D-Bus method, overloaded to insert property tags.
1400
"""Overloading of standard D-Bus method.
1401
1402
Inserts property tags and interface annotation tags.
715
1403
"""
716
xmlstring = dbus.service.Object.Introspect(self, object_path,
717
connection)
1404
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1405
object_path,
1406
connection)
718
1407
try:
719
1408
document = xml.dom.minidom.parseString(xmlstring)
1409
720
1410
def make_tag(document, name, prop):
721
1411
e = document.createElement("property")
722
1412
e.setAttribute("name", name)
723
1413
e.setAttribute("type", prop._dbus_signature)
724
1414
e.setAttribute("access", prop._dbus_access)
725
1415
return e
1416
726
1417
for if_tag in document.getElementsByTagName("interface"):
1418
# Add property tags
727
1419
for tag in (make_tag(document, name, prop)
728
1420
for name, prop
729
in self._get_all_dbus_properties()
1421
in self._get_all_dbus_things("property")
730
1422
if prop._dbus_interface
731
1423
== if_tag.getAttribute("name")):
732
1424
if_tag.appendChild(tag)
1425
# Add annotation tags for properties
1426
for tag in if_tag.getElementsByTagName("property"):
1427
annots = dict()
1428
for name, prop in self._get_all_dbus_things(
1429
"property"):
1430
if (name == tag.getAttribute("name")
1431
and prop._dbus_interface
1432
== if_tag.getAttribute("name")):
1433
annots.update(getattr(
1434
prop, "_dbus_annotations", {}))
1435
for name, value in annots.items():
1436
ann_tag = document.createElement(
1437
"annotation")
1438
ann_tag.setAttribute("name", name)
1439
ann_tag.setAttribute("value", value)
1440
tag.appendChild(ann_tag)
733
1441
# Add the names to the return values for the
734
1442
# "org.freedesktop.DBus.Properties" methods
735
1443
if (if_tag.getAttribute("name")
750
1458
except (AttributeError, xml.dom.DOMException,
751
1459
xml.parsers.expat.ExpatError) as error:
752
1460
logger.error("Failed to override Introspection method",
753
error)
754
return xmlstring
755
756
757
def datetime_to_dbus (dt, variant_level=0):
1461
exc_info=error)
1462
return xmlstring
1463
1464
try:
1465
dbus.OBJECT_MANAGER_IFACE
1466
except AttributeError:
1467
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1468
1469
1470
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1471
"""A D-Bus object with an ObjectManager.
1472
1473
Classes inheriting from this exposes the standard
1474
GetManagedObjects call and the InterfacesAdded and
1475
InterfacesRemoved signals on the standard
1476
"org.freedesktop.DBus.ObjectManager" interface.
1477
1478
Note: No signals are sent automatically; they must be sent
1479
manually.
1480
"""
1481
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1482
out_signature="a{oa{sa{sv}}}")
1483
def GetManagedObjects(self):
1484
"""This function must be overridden"""
1485
raise NotImplementedError()
1486
1487
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1488
signature="oa{sa{sv}}")
1489
def InterfacesAdded(self, object_path, interfaces_and_properties):
1490
pass
1491
1492
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1493
def InterfacesRemoved(self, object_path, interfaces):
1494
pass
1495
1496
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1497
out_signature="s",
1498
path_keyword='object_path',
1499
connection_keyword='connection')
1500
def Introspect(self, object_path, connection):
1501
"""Overloading of standard D-Bus method.
1502
1503
Override return argument name of GetManagedObjects to be
1504
"objpath_interfaces_and_properties"
1505
"""
1506
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1507
object_path,
1508
connection)
1509
try:
1510
document = xml.dom.minidom.parseString(xmlstring)
1511
1512
for if_tag in document.getElementsByTagName("interface"):
1513
# Fix argument name for the GetManagedObjects method
1514
if (if_tag.getAttribute("name")
1515
== dbus.OBJECT_MANAGER_IFACE):
1516
for cn in if_tag.getElementsByTagName("method"):
1517
if (cn.getAttribute("name")
1518
== "GetManagedObjects"):
1519
for arg in cn.getElementsByTagName("arg"):
1520
if (arg.getAttribute("direction")
1521
== "out"):
1522
arg.setAttribute(
1523
"name",
1524
"objpath_interfaces"
1525
"_and_properties")
1526
xmlstring = document.toxml("utf-8")
1527
document.unlink()
1528
except (AttributeError, xml.dom.DOMException,
1529
xml.parsers.expat.ExpatError) as error:
1530
logger.error("Failed to override Introspection method",
1531
exc_info=error)
1532
return xmlstring
1533
1534
1535
def datetime_to_dbus(dt, variant_level=0):
758
1536
"""Convert a UTC datetime.datetime() to a D-Bus type."""
759
1537
if dt is None:
760
return dbus.String("", variant_level = variant_level)
761
return dbus.String(dt.isoformat(),
762
variant_level=variant_level)
763
764
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
765
.__metaclass__):
766
"""Applied to an empty subclass of a D-Bus object, this metaclass
767
will add additional D-Bus attributes matching a certain pattern.
1538
return dbus.String("", variant_level=variant_level)
1539
return dbus.String(dt.isoformat(), variant_level=variant_level)
1540
1541
1542
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1543
"""A class decorator; applied to a subclass of
1544
dbus.service.Object, it will add alternate D-Bus attributes with
1545
interface names according to the "alt_interface_names" mapping.
1546
Usage:
1547
1548
@alternate_dbus_interfaces({"org.example.Interface":
1549
"net.example.AlternateInterface"})
1550
class SampleDBusObject(dbus.service.Object):
1551
@dbus.service.method("org.example.Interface")
1552
def SampleDBusMethod():
1553
pass
1554
1555
The above "SampleDBusMethod" on "SampleDBusObject" will be
1556
reachable via two interfaces: "org.example.Interface" and
1557
"net.example.AlternateInterface", the latter of which will have
1558
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1559
"true", unless "deprecate" is passed with a False value.
1560
1561
This works for methods and signals, and also for D-Bus properties
1562
(from DBusObjectWithProperties) and interfaces (from the
1563
dbus_interface_annotations decorator).
768
1564
"""
769
def __new__(mcs, name, bases, attr):
770
# Go through all the base classes which could have D-Bus
771
# methods, signals, or properties in them
772
for base in (b for b in bases
773
if issubclass(b, dbus.service.Object)):
774
# Go though all attributes of the base class
775
for attrname, attribute in inspect.getmembers(base):
1565
1566
def wrapper(cls):
1567
for orig_interface_name, alt_interface_name in (
1568
alt_interface_names.items()):
1569
attr = {}
1570
interface_names = set()
1571
# Go though all attributes of the class
1572
for attrname, attribute in inspect.getmembers(cls):
776
1573
# Ignore non-D-Bus attributes, and D-Bus attributes
777
1574
# with the wrong interface name
778
1575
if (not hasattr(attribute, "_dbus_interface")
779
or not attribute._dbus_interface
780
.startswith("se.recompile.Mandos")):
1576
or not attribute._dbus_interface.startswith(
1577
orig_interface_name)):
781
1578
continue
782
1579
# Create an alternate D-Bus interface name based on
783
1580
# the current name
784
alt_interface = (attribute._dbus_interface
785
.replace("se.recompile.Mandos",
786
"se.bsnet.fukt.Mandos"))
1581
alt_interface = attribute._dbus_interface.replace(
1582
orig_interface_name, alt_interface_name)
1583
interface_names.add(alt_interface)
787
1584
# Is this a D-Bus signal?
788
1585
if getattr(attribute, "_dbus_is_signal", False):
789
# Extract the original non-method function by
790
# black magic
791
nonmethod_func = (dict(
1586
# Extract the original non-method undecorated
1587
# function by black magic
1588
if sys.version_info.major == 2:
1589
nonmethod_func = (dict(
792
1590
zip(attribute.func_code.co_freevars,
793
attribute.__closure__))["func"]
794
.cell_contents)
1591
attribute.__closure__))
1592
["func"].cell_contents)
1593
else:
1594
nonmethod_func = (dict(
1595
zip(attribute.__code__.co_freevars,
1596
attribute.__closure__))
1597
["func"].cell_contents)
795
1598
# Create a new, but exactly alike, function
796
1599
# object, and decorate it to be a new D-Bus signal
797
1600
# with the alternate D-Bus interface name
798
new_function = (dbus.service.signal
799
(alt_interface,
800
attribute._dbus_signature)
801
(types.FunctionType(
802
nonmethod_func.func_code,
803
nonmethod_func.func_globals,
804
nonmethod_func.func_name,
805
nonmethod_func.func_defaults,
806
nonmethod_func.func_closure)))
1601
new_function = copy_function(nonmethod_func)
1602
new_function = (dbus.service.signal(
1603
alt_interface,
1604
attribute._dbus_signature)(new_function))
1605
# Copy annotations, if any
1606
try:
1607
new_function._dbus_annotations = dict(
1608
attribute._dbus_annotations)
1609
except AttributeError:
1610
pass
1611
807
1612
# Define a creator of a function to call both the
808
# old and new functions, so both the old and new
809
# signals gets sent when the function is called
1613
# original and alternate functions, so both the
1614
# original and alternate signals gets sent when
1615
# the function is called
810
1616
def fixscope(func1, func2):
811
1617
"""This function is a scope container to pass
812
1618
func1 and func2 to the "call_both" function
813
1619
outside of its arguments"""
1620
1621
@functools.wraps(func2)
814
1622
def call_both(*args, **kwargs):
815
1623
"""This function will emit two D-Bus
816
1624
signals by calling func1 and func2"""
817
1625
func1(*args, **kwargs)
818
1626
func2(*args, **kwargs)
1627
# Make wrapper function look like a D-Bus
1628
# signal
1629
for name, attr in inspect.getmembers(func2):
1630
if name.startswith("_dbus_"):
1631
setattr(call_both, name, attr)
1632
819
1633
return call_both
820
1634
# Create the "call_both" function and add it to
821
1635
# the class
822
attr[attrname] = fixscope(attribute,
823
new_function)
1636
attr[attrname] = fixscope(attribute, new_function)
824
1637
# Is this a D-Bus method?
825
1638
elif getattr(attribute, "_dbus_is_method", False):
826
1639
# Create a new, but exactly alike, function
827
1640
# object. Decorate it to be a new D-Bus method
828
1641
# with the alternate D-Bus interface name. Add it
829
1642
# to the class.
830
attr[attrname] = (dbus.service.method
831
(alt_interface,
832
attribute._dbus_in_signature,
833
attribute._dbus_out_signature)
834
(types.FunctionType
835
(attribute.func_code,
836
attribute.func_globals,
837
attribute.func_name,
838
attribute.func_defaults,
839
attribute.func_closure)))
1643
attr[attrname] = (
1644
dbus.service.method(
1645
alt_interface,
1646
attribute._dbus_in_signature,
1647
attribute._dbus_out_signature)
1648
(copy_function(attribute)))
1649
# Copy annotations, if any
1650
try:
1651
attr[attrname]._dbus_annotations = dict(
1652
attribute._dbus_annotations)
1653
except AttributeError:
1654
pass
840
1655
# Is this a D-Bus property?
841
1656
elif getattr(attribute, "_dbus_is_property", False):
842
1657
# Create a new, but exactly alike, function
843
1658
# object, and decorate it to be a new D-Bus
844
1659
# property with the alternate D-Bus interface
845
1660
# name. Add it to the class.
846
attr[attrname] = (dbus_service_property
847
(alt_interface,
848
attribute._dbus_signature,
849
attribute._dbus_access,
850
attribute
851
._dbus_get_args_options
852
["byte_arrays"])
853
(types.FunctionType
854
(attribute.func_code,
855
attribute.func_globals,
856
attribute.func_name,
857
attribute.func_defaults,
858
attribute.func_closure)))
859
return type.__new__(mcs, name, bases, attr)
860
1661
attr[attrname] = (dbus_service_property(
1662
alt_interface, attribute._dbus_signature,
1663
attribute._dbus_access,
1664
attribute._dbus_get_args_options
1665
["byte_arrays"])
1666
(copy_function(attribute)))
1667
# Copy annotations, if any
1668
try:
1669
attr[attrname]._dbus_annotations = dict(
1670
attribute._dbus_annotations)
1671
except AttributeError:
1672
pass
1673
# Is this a D-Bus interface?
1674
elif getattr(attribute, "_dbus_is_interface", False):
1675
# Create a new, but exactly alike, function
1676
# object. Decorate it to be a new D-Bus interface
1677
# with the alternate D-Bus interface name. Add it
1678
# to the class.
1679
attr[attrname] = (
1680
dbus_interface_annotations(alt_interface)
1681
(copy_function(attribute)))
1682
if deprecate:
1683
# Deprecate all alternate interfaces
1684
iname = "_AlternateDBusNames_interface_annotation{}"
1685
for interface_name in interface_names:
1686
1687
@dbus_interface_annotations(interface_name)
1688
def func(self):
1689
return {"org.freedesktop.DBus.Deprecated":
1690
"true"}
1691
# Find an unused name
1692
for aname in (iname.format(i)
1693
for i in itertools.count()):
1694
if aname not in attr:
1695
attr[aname] = func
1696
break
1697
if interface_names:
1698
# Replace the class with a new subclass of it with
1699
# methods, signals, etc. as created above.
1700
if sys.version_info.major == 2:
1701
cls = type(b"{}Alternate".format(cls.__name__),
1702
(cls, ), attr)
1703
else:
1704
cls = type("{}Alternate".format(cls.__name__),
1705
(cls, ), attr)
1706
return cls
1707
1708
return wrapper
1709
1710
1711
@alternate_dbus_interfaces({"se.recompile.Mandos":
1712
"se.bsnet.fukt.Mandos"})
861
1713
class ClientDBus(Client, DBusObjectWithProperties):
862
1714
"""A Client class using D-Bus
863
1715
864
1716
Attributes:
865
1717
dbus_object_path: dbus.ObjectPath
866
1718
bus: dbus.SystemBus()
867
1719
"""
868
1720
869
1721
runtime_expansions = (Client.runtime_expansions
870
+ ("dbus_object_path",))
871
1722
+ ("dbus_object_path", ))
1723
1724
_interface = "se.recompile.Mandos.Client"
1725
872
1726
# dbus.service.Object doesn't use super(), so we can't either.
873
874
def __init__(self, bus = None, *args, **kwargs):
875
self._approvals_pending = 0
1727
1728
def __init__(self, bus=None, *args, **kwargs):
876
1729
self.bus = bus
877
1730
Client.__init__(self, *args, **kwargs)
878
1731
# Only now, when this client is initialized, can it show up on
879
1732
# the D-Bus
880
client_object_name = unicode(self.name).translate(
1733
client_object_name = str(self.name).translate(
881
1734
{ord("."): ord("_"),
882
1735
ord("-"): ord("_")})
883
self.dbus_object_path = (dbus.ObjectPath
884
("/clients/" + client_object_name))
1736
self.dbus_object_path = dbus.ObjectPath(
1737
"/clients/" + client_object_name)
885
1738
DBusObjectWithProperties.__init__(self, self.bus,
886
1739
self.dbus_object_path)
887
888
def notifychangeproperty(transform_func,
889
dbus_name, type_func=lambda x: x,
890
variant_level=1):
1740
1741
def notifychangeproperty(transform_func, dbus_name,
1742
type_func=lambda x: x,
1743
variant_level=1,
1744
invalidate_only=False,
1745
_interface=_interface):
891
1746
""" Modify a variable so that it's a property which announces
892
1747
its changes to DBus.
893
1748
894
transform_fun: Function that takes a value and transforms it
895
to a D-Bus type.
1749
transform_fun: Function that takes a value and a variant_level
1750
and transforms it to a D-Bus type.
896
1751
dbus_name: D-Bus name of the variable
897
1752
type_func: Function that transform the value before sending it
898
1753
to the D-Bus. Default: no transform
899
1754
variant_level: D-Bus variant level. Default: 1
900
1755
"""
901
attrname = "_{0}".format(dbus_name)
1756
attrname = "_{}".format(dbus_name)
1757
902
1758
def setter(self, value):
903
1759
if hasattr(self, "dbus_object_path"):
904
1760
if (not hasattr(self, attrname) or
905
1761
type_func(getattr(self, attrname, None))
906
1762
!= type_func(value)):
907
dbus_value = transform_func(type_func(value),
908
variant_level)
909
self.PropertyChanged(dbus.String(dbus_name),
910
dbus_value)
1763
if invalidate_only:
1764
self.PropertiesChanged(
1765
_interface, dbus.Dictionary(),
1766
dbus.Array((dbus_name, )))
1767
else:
1768
dbus_value = transform_func(
1769
type_func(value),
1770
variant_level=variant_level)
1771
self.PropertyChanged(dbus.String(dbus_name),
1772
dbus_value)
1773
self.PropertiesChanged(
1774
_interface,
1775
dbus.Dictionary({dbus.String(dbus_name):
1776
dbus_value}),
1777
dbus.Array())
911
1778
setattr(self, attrname, value)
912
1779
913
1780
return property(lambda self: getattr(self, attrname), setter)
914
915
1781
916
1782
expires = notifychangeproperty(datetime_to_dbus, "Expires")
917
1783
approvals_pending = notifychangeproperty(dbus.Boolean,
918
1784
"ApprovalPending",
919
type_func = bool)
1785
type_func=bool)
920
1786
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
921
1787
last_enabled = notifychangeproperty(datetime_to_dbus,
922
1788
"LastEnabled")
923
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
924
type_func = lambda checker:
925
checker is not None)
1789
checker = notifychangeproperty(
1790
dbus.Boolean, "CheckerRunning",
1791
type_func=lambda checker: checker is not None)
926
1792
last_checked_ok = notifychangeproperty(datetime_to_dbus,
927
1793
"LastCheckedOK")
1794
last_checker_status = notifychangeproperty(dbus.Int16,
1795
"LastCheckerStatus")
928
1796
last_approval_request = notifychangeproperty(
929
1797
datetime_to_dbus, "LastApprovalRequest")
930
1798
approved_by_default = notifychangeproperty(dbus.Boolean,
931
1799
"ApprovedByDefault")
932
approval_delay = notifychangeproperty(dbus.UInt16,
933
"ApprovalDelay",
934
type_func =
935
_timedelta_to_milliseconds)
1800
approval_delay = notifychangeproperty(
1801
dbus.UInt64, "ApprovalDelay",
1802
type_func=lambda td: td.total_seconds() * 1000)
936
1803
approval_duration = notifychangeproperty(
937
dbus.UInt16, "ApprovalDuration",
938
type_func = _timedelta_to_milliseconds)
1804
dbus.UInt64, "ApprovalDuration",
1805
type_func=lambda td: td.total_seconds() * 1000)
939
1806
host = notifychangeproperty(dbus.String, "Host")
940
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
941
type_func =
942
_timedelta_to_milliseconds)
1807
timeout = notifychangeproperty(
1808
dbus.UInt64, "Timeout",
1809
type_func=lambda td: td.total_seconds() * 1000)
943
1810
extended_timeout = notifychangeproperty(
944
dbus.UInt16, "ExtendedTimeout",
945
type_func = _timedelta_to_milliseconds)
946
interval = notifychangeproperty(dbus.UInt16,
947
"Interval",
948
type_func =
949
_timedelta_to_milliseconds)
1811
dbus.UInt64, "ExtendedTimeout",
1812
type_func=lambda td: td.total_seconds() * 1000)
1813
interval = notifychangeproperty(
1814
dbus.UInt64, "Interval",
1815
type_func=lambda td: td.total_seconds() * 1000)
950
1816
checker_command = notifychangeproperty(dbus.String, "Checker")
951
1817
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1818
invalidate_only=True)
1819
952
1820
del notifychangeproperty
953
1821
954
1822
def __del__(self, *args, **kwargs):
955
1823
try:
956
1824
self.remove_from_connection()
959
1827
if hasattr(DBusObjectWithProperties, "__del__"):
960
1828
DBusObjectWithProperties.__del__(self, *args, **kwargs)
961
1829
Client.__del__(self, *args, **kwargs)
962
963
def checker_callback(self, pid, condition, command,
964
*args, **kwargs):
965
self.checker_callback_tag = None
966
self.checker = None
967
if os.WIFEXITED(condition):
968
exitstatus = os.WEXITSTATUS(condition)
1830
1831
def checker_callback(self, source, condition,
1832
connection, command, *args, **kwargs):
1833
ret = Client.checker_callback(self, source, condition,
1834
connection, command, *args,
1835
**kwargs)
1836
exitstatus = self.last_checker_status
1837
if exitstatus >= 0:
969
1838
# Emit D-Bus signal
970
1839
self.CheckerCompleted(dbus.Int16(exitstatus),
971
dbus.Int64(condition),
1840
# This is specific to GNU libC
1841
dbus.Int64(exitstatus << 8),
972
1842
dbus.String(command))
973
1843
else:
974
1844
# Emit D-Bus signal
975
1845
self.CheckerCompleted(dbus.Int16(-1),
976
dbus.Int64(condition),
1846
dbus.Int64(
1847
# This is specific to GNU libC
1848
(exitstatus << 8)
1849
| self.last_checker_signal),
977
1850
dbus.String(command))
978
979
return Client.checker_callback(self, pid, condition, command,
980
*args, **kwargs)
981
1851
return ret
1852
982
1853
def start_checker(self, *args, **kwargs):
983
old_checker = self.checker
984
if self.checker is not None:
985
old_checker_pid = self.checker.pid
986
else:
987
old_checker_pid = None
1854
old_checker_pid = getattr(self.checker, "pid", None)
988
1855
r = Client.start_checker(self, *args, **kwargs)
989
1856
# Only if new checker process was started
990
1857
if (self.checker is not None
992
1859
# Emit D-Bus signal
993
1860
self.CheckerStarted(self.current_checker_command)
994
1861
return r
995
1862
996
1863
def _reset_approved(self):
997
self._approved = None
1864
self.approved = None
998
1865
return False
999
1866
1000
1867
def approve(self, value=True):
1868
self.approved = value
1869
GLib.timeout_add(int(self.approval_duration.total_seconds()
1870
* 1000), self._reset_approved)
1001
1871
self.send_changedstate()
1002
self._approved = value
1003
gobject.timeout_add(_timedelta_to_milliseconds
1004
(self.approval_duration),
1005
self._reset_approved)
1006
1007
1008
## D-Bus methods, signals & properties
1009
_interface = "se.recompile.Mandos.Client"
1010
1011
## Signals
1012
1872
1873
# D-Bus methods, signals & properties
1874
1875
# Interfaces
1876
1877
# Signals
1878
1013
1879
# CheckerCompleted - signal
1014
1880
@dbus.service.signal(_interface, signature="nxs")
1015
1881
def CheckerCompleted(self, exitcode, waitstatus, command):
1016
1882
"D-Bus signal"
1017
1883
pass
1018
1884
1019
1885
# CheckerStarted - signal
1020
1886
@dbus.service.signal(_interface, signature="s")
1021
1887
def CheckerStarted(self, command):
1022
1888
"D-Bus signal"
1023
1889
pass
1024
1890
1025
1891
# PropertyChanged - signal
1892
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1026
1893
@dbus.service.signal(_interface, signature="sv")
1027
1894
def PropertyChanged(self, property, value):
1028
1895
"D-Bus signal"
1029
1896
pass
1030
1897
1031
1898
# GotSecret - signal
1032
1899
@dbus.service.signal(_interface)
1033
1900
def GotSecret(self):
1036
1903
server to mandos-client
1037
1904
"""
1038
1905
pass
1039
1906
1040
1907
# Rejected - signal
1041
1908
@dbus.service.signal(_interface, signature="s")
1042
1909
def Rejected(self, reason):
1043
1910
"D-Bus signal"
1044
1911
pass
1045
1912
1046
1913
# NeedApproval - signal
1047
1914
@dbus.service.signal(_interface, signature="tb")
1048
1915
def NeedApproval(self, timeout, default):
1049
1916
"D-Bus signal"
1050
1917
return self.need_approval()
1051
1052
## Methods
1053
1918
1919
# Methods
1920
1054
1921
# Approve - method
1055
1922
@dbus.service.method(_interface, in_signature="b")
1056
1923
def Approve(self, value):
1057
1924
self.approve(value)
1058
1925
1059
1926
# CheckedOK - method
1060
1927
@dbus.service.method(_interface)
1061
1928
def CheckedOK(self):
1062
1929
self.checked_ok()
1063
1930
1064
1931
# Enable - method
1932
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1065
1933
@dbus.service.method(_interface)
1066
1934
def Enable(self):
1067
1935
"D-Bus method"
1068
1936
self.enable()
1069
1937
1070
1938
# StartChecker - method
1939
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1071
1940
@dbus.service.method(_interface)
1072
1941
def StartChecker(self):
1073
1942
"D-Bus method"
1074
1943
self.start_checker()
1075
1944
1076
1945
# Disable - method
1946
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1077
1947
@dbus.service.method(_interface)
1078
1948
def Disable(self):
1079
1949
"D-Bus method"
1080
1950
self.disable()
1081
1951
1082
1952
# StopChecker - method
1953
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1083
1954
@dbus.service.method(_interface)
1084
1955
def StopChecker(self):
1085
1956
self.stop_checker()
1086
1087
## Properties
1088
1957
1958
# Properties
1959
1089
1960
# ApprovalPending - property
1090
1961
@dbus_service_property(_interface, signature="b", access="read")
1091
1962
def ApprovalPending_dbus_property(self):
1092
1963
return dbus.Boolean(bool(self.approvals_pending))
1093
1964
1094
1965
# ApprovedByDefault - property
1095
@dbus_service_property(_interface, signature="b",
1966
@dbus_service_property(_interface,
1967
signature="b",
1096
1968
access="readwrite")
1097
1969
def ApprovedByDefault_dbus_property(self, value=None):
1098
1970
if value is None: # get
1099
1971
return dbus.Boolean(self.approved_by_default)
1100
1972
self.approved_by_default = bool(value)
1101
1973
1102
1974
# ApprovalDelay - property
1103
@dbus_service_property(_interface, signature="t",
1975
@dbus_service_property(_interface,
1976
signature="t",
1104
1977
access="readwrite")
1105
1978
def ApprovalDelay_dbus_property(self, value=None):
1106
1979
if value is None: # get
1107
return dbus.UInt64(self.approval_delay_milliseconds())
1980
return dbus.UInt64(self.approval_delay.total_seconds()
1981
* 1000)
1108
1982
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1109
1983
1110
1984
# ApprovalDuration - property
1111
@dbus_service_property(_interface, signature="t",
1985
@dbus_service_property(_interface,
1986
signature="t",
1112
1987
access="readwrite")
1113
1988
def ApprovalDuration_dbus_property(self, value=None):
1114
1989
if value is None: # get
1115
return dbus.UInt64(_timedelta_to_milliseconds(
1116
self.approval_duration))
1990
return dbus.UInt64(self.approval_duration.total_seconds()
1991
* 1000)
1117
1992
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1118
1993
1119
1994
# Name - property
1995
@dbus_annotations(
1996
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1120
1997
@dbus_service_property(_interface, signature="s", access="read")
1121
1998
def Name_dbus_property(self):
1122
1999
return dbus.String(self.name)
1123
2000
1124
2001
# Fingerprint - property
2002
@dbus_annotations(
2003
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1125
2004
@dbus_service_property(_interface, signature="s", access="read")
1126
2005
def Fingerprint_dbus_property(self):
1127
2006
return dbus.String(self.fingerprint)
1128
2007
1129
2008
# Host - property
1130
@dbus_service_property(_interface, signature="s",
2009
@dbus_service_property(_interface,
2010
signature="s",
1131
2011
access="readwrite")
1132
2012
def Host_dbus_property(self, value=None):
1133
2013
if value is None: # get
1134
2014
return dbus.String(self.host)
1135
self.host = value
1136
2015
self.host = str(value)
2016
1137
2017
# Created - property
2018
@dbus_annotations(
2019
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1138
2020
@dbus_service_property(_interface, signature="s", access="read")
1139
2021
def Created_dbus_property(self):
1140
return dbus.String(datetime_to_dbus(self.created))
1141
2022
return datetime_to_dbus(self.created)
2023
1142
2024
# LastEnabled - property
1143
2025
@dbus_service_property(_interface, signature="s", access="read")
1144
2026
def LastEnabled_dbus_property(self):
1145
2027
return datetime_to_dbus(self.last_enabled)
1146
2028
1147
2029
# Enabled - property
1148
@dbus_service_property(_interface, signature="b",
2030
@dbus_service_property(_interface,
2031
signature="b",
1149
2032
access="readwrite")
1150
2033
def Enabled_dbus_property(self, value=None):
1151
2034
if value is None: # get
1154
2037
self.enable()
1155
2038
else:
1156
2039
self.disable()
1157
2040
1158
2041
# LastCheckedOK - property
1159
@dbus_service_property(_interface, signature="s",
2042
@dbus_service_property(_interface,
2043
signature="s",
1160
2044
access="readwrite")
1161
2045
def LastCheckedOK_dbus_property(self, value=None):
1162
2046
if value is not None:
1163
2047
self.checked_ok()
1164
2048
return
1165
2049
return datetime_to_dbus(self.last_checked_ok)
1166
2050
2051
# LastCheckerStatus - property
2052
@dbus_service_property(_interface, signature="n", access="read")
2053
def LastCheckerStatus_dbus_property(self):
2054
return dbus.Int16(self.last_checker_status)
2055
1167
2056
# Expires - property
1168
2057
@dbus_service_property(_interface, signature="s", access="read")
1169
2058
def Expires_dbus_property(self):
1170
2059
return datetime_to_dbus(self.expires)
1171
2060
1172
2061
# LastApprovalRequest - property
1173
2062
@dbus_service_property(_interface, signature="s", access="read")
1174
2063
def LastApprovalRequest_dbus_property(self):
1175
2064
return datetime_to_dbus(self.last_approval_request)
1176
2065
1177
2066
# Timeout - property
1178
@dbus_service_property(_interface, signature="t",
2067
@dbus_service_property(_interface,
2068
signature="t",
1179
2069
access="readwrite")
1180
2070
def Timeout_dbus_property(self, value=None):
1181
2071
if value is None: # get
1182
return dbus.UInt64(self.timeout_milliseconds())
2072
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2073
old_timeout = self.timeout
1183
2074
self.timeout = datetime.timedelta(0, 0, 0, value)
1184
if getattr(self, "disable_initiator_tag", None) is None:
1185
return
1186
# Reschedule timeout
1187
gobject.source_remove(self.disable_initiator_tag)
1188
self.disable_initiator_tag = None
1189
self.expires = None
1190
time_to_die = (self.
1191
_timedelta_to_milliseconds((self
1192
.last_checked_ok
1193
+ self.timeout)
1194
- datetime.datetime
1195
.utcnow()))
1196
if time_to_die <= 0:
1197
# The timeout has passed
1198
self.disable()
1199
else:
1200
self.expires = (datetime.datetime.utcnow()
1201
+ datetime.timedelta(milliseconds =
1202
time_to_die))
1203
self.disable_initiator_tag = (gobject.timeout_add
1204
(time_to_die, self.disable))
1205
2075
# Reschedule disabling
2076
if self.enabled:
2077
now = datetime.datetime.utcnow()
2078
self.expires += self.timeout - old_timeout
2079
if self.expires <= now:
2080
# The timeout has passed
2081
self.disable()
2082
else:
2083
if (getattr(self, "disable_initiator_tag", None)
2084
is None):
2085
return
2086
GLib.source_remove(self.disable_initiator_tag)
2087
self.disable_initiator_tag = GLib.timeout_add(
2088
int((self.expires - now).total_seconds() * 1000),
2089
self.disable)
2090
1206
2091
# ExtendedTimeout - property
1207
@dbus_service_property(_interface, signature="t",
2092
@dbus_service_property(_interface,
2093
signature="t",
1208
2094
access="readwrite")
1209
2095
def ExtendedTimeout_dbus_property(self, value=None):
1210
2096
if value is None: # get
1211
return dbus.UInt64(self.extended_timeout_milliseconds())
2097
return dbus.UInt64(self.extended_timeout.total_seconds()
2098
* 1000)
1212
2099
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1213
2100
1214
2101
# Interval - property
1215
@dbus_service_property(_interface, signature="t",
2102
@dbus_service_property(_interface,
2103
signature="t",
1216
2104
access="readwrite")
1217
2105
def Interval_dbus_property(self, value=None):
1218
2106
if value is None: # get
1219
return dbus.UInt64(self.interval_milliseconds())
2107
return dbus.UInt64(self.interval.total_seconds() * 1000)
1220
2108
self.interval = datetime.timedelta(0, 0, 0, value)
1221
2109
if getattr(self, "checker_initiator_tag", None) is None:
1222
2110
return
1223
# Reschedule checker run
1224
gobject.source_remove(self.checker_initiator_tag)
1225
self.checker_initiator_tag = (gobject.timeout_add
1226
(value, self.start_checker))
1227
self.start_checker() # Start one now, too
1228
2111
if self.enabled:
2112
# Reschedule checker run
2113
GLib.source_remove(self.checker_initiator_tag)
2114
self.checker_initiator_tag = GLib.timeout_add(
2115
value, self.start_checker)
2116
self.start_checker() # Start one now, too
2117
1229
2118
# Checker - property
1230
@dbus_service_property(_interface, signature="s",
2119
@dbus_service_property(_interface,
2120
signature="s",
1231
2121
access="readwrite")
1232
2122
def Checker_dbus_property(self, value=None):
1233
2123
if value is None: # get
1234
2124
return dbus.String(self.checker_command)
1235
self.checker_command = value
1236
2125
self.checker_command = str(value)
2126
1237
2127
# CheckerRunning - property
1238
@dbus_service_property(_interface, signature="b",
2128
@dbus_service_property(_interface,
2129
signature="b",
1239
2130
access="readwrite")
1240
2131
def CheckerRunning_dbus_property(self, value=None):
1241
2132
if value is None: # get
1244
2135
self.start_checker()
1245
2136
else:
1246
2137
self.stop_checker()
1247
2138
1248
2139
# ObjectPath - property
2140
@dbus_annotations(
2141
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2142
"org.freedesktop.DBus.Deprecated": "true"})
1249
2143
@dbus_service_property(_interface, signature="o", access="read")
1250
2144
def ObjectPath_dbus_property(self):
1251
return self.dbus_object_path # is already a dbus.ObjectPath
1252
2145
return self.dbus_object_path # is already a dbus.ObjectPath
2146
1253
2147
# Secret = property
1254
@dbus_service_property(_interface, signature="ay",
1255
access="write", byte_arrays=True)
2148
@dbus_annotations(
2149
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2150
"invalidates"})
2151
@dbus_service_property(_interface,
2152
signature="ay",
2153
access="write",
2154
byte_arrays=True)
1256
2155
def Secret_dbus_property(self, value):
1257
self.secret = str(value)
1258
2156
self.secret = bytes(value)
2157
1259
2158
del _interface
1260
2159
1261
2160
1264
2163
self._pipe = child_pipe
1265
2164
self._pipe.send(('init', fpr, address))
1266
2165
if not self._pipe.recv():
1267
raise KeyError()
1268
2166
raise KeyError(fpr)
2167
1269
2168
def __getattribute__(self, name):
1270
if(name == '_pipe'):
2169
if name == '_pipe':
1271
2170
return super(ProxyClient, self).__getattribute__(name)
1272
2171
self._pipe.send(('getattr', name))
1273
2172
data = self._pipe.recv()
1274
2173
if data[0] == 'data':
1275
2174
return data[1]
1276
2175
if data[0] == 'function':
2176
1277
2177
def func(*args, **kwargs):
1278
2178
self._pipe.send(('funcall', name, args, kwargs))
1279
2179
return self._pipe.recv()[1]
2180
1280
2181
return func
1281
2182
1282
2183
def __setattr__(self, name, value):
1283
if(name == '_pipe'):
2184
if name == '_pipe':
1284
2185
return super(ProxyClient, self).__setattr__(name, value)
1285
2186
self._pipe.send(('setattr', name, value))
1286
2187
1287
class ClientDBusTransitional(ClientDBus):
1288
__metaclass__ = AlternateDBusNamesMetaclass
1289
2188
1290
2189
class ClientHandler(socketserver.BaseRequestHandler, object):
1291
2190
"""A class to handle client connections.
1292
2191
1293
2192
Instantiated once for each connection to handle it.
1294
2193
Note: This will run in its own forked process."""
1295
2194
1296
2195
def handle(self):
1297
2196
with contextlib.closing(self.server.child_pipe) as child_pipe:
1298
2197
logger.info("TCP connection from: %s",
1299
unicode(self.client_address))
2198
str(self.client_address))
1300
2199
logger.debug("Pipe FD: %d",
1301
2200
self.server.child_pipe.fileno())
1302
1303
session = (gnutls.connection
1304
.ClientSession(self.request,
1305
gnutls.connection
1306
.X509Credentials()))
1307
1308
# Note: gnutls.connection.X509Credentials is really a
1309
# generic GnuTLS certificate credentials object so long as
1310
# no X.509 keys are added to it. Therefore, we can use it
1311
# here despite using OpenPGP certificates.
1312
1313
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1314
# "+AES-256-CBC", "+SHA1",
1315
# "+COMP-NULL", "+CTYPE-OPENPGP",
1316
# "+DHE-DSS"))
2201
2202
session = gnutls.ClientSession(self.request)
2203
2204
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2205
# "+AES-256-CBC", "+SHA1",
2206
# "+COMP-NULL", "+CTYPE-OPENPGP",
2207
# "+DHE-DSS"))
1317
2208
# Use a fallback default, since this MUST be set.
1318
2209
priority = self.server.gnutls_priority
1319
2210
if priority is None:
1320
2211
priority = "NORMAL"
1321
(gnutls.library.functions
1322
.gnutls_priority_set_direct(session._c_object,
1323
priority, None))
1324
2212
gnutls.priority_set_direct(session._c_object,
2213
priority.encode("utf-8"),
2214
None)
2215
1325
2216
# Start communication using the Mandos protocol
1326
2217
# Get protocol number
1327
2218
line = self.request.makefile().readline()
1328
2219
logger.debug("Protocol version: %r", line)
1329
2220
try:
1330
2221
if int(line.strip().split()[0]) > 1:
1331
raise RuntimeError
2222
raise RuntimeError(line)
1332
2223
except (ValueError, IndexError, RuntimeError) as error:
1333
2224
logger.error("Unknown protocol version: %s", error)
1334
2225
return
1335
2226
1336
2227
# Start GnuTLS connection
1337
2228
try:
1338
2229
session.handshake()
1339
except gnutls.errors.GNUTLSError as error:
2230
except gnutls.Error as error:
1340
2231
logger.warning("Handshake failed: %s", error)
1341
2232
# Do not run session.bye() here: the session is not
1342
2233
# established. Just abandon the request.
1343
2234
return
1344
2235
logger.debug("Handshake succeeded")
1345
2236
1346
2237
approval_required = False
1347
2238
try:
1348
2239
try:
1349
fpr = self.fingerprint(self.peer_certificate
1350
(session))
1351
except (TypeError,
1352
gnutls.errors.GNUTLSError) as error:
2240
fpr = self.fingerprint(
2241
self.peer_certificate(session))
2242
except (TypeError, gnutls.Error) as error:
1353
2243
logger.warning("Bad certificate: %s", error)
1354
2244
return
1355
2245
logger.debug("Fingerprint: %s", fpr)
1356
2246
1357
2247
try:
1358
2248
client = ProxyClient(child_pipe, fpr,
1359
2249
self.client_address)
1360
2250
except KeyError:
1361
2251
return
1362
2252
1363
2253
if client.approval_delay:
1364
2254
delay = client.approval_delay
1365
2255
client.approvals_pending += 1
1366
2256
approval_required = True
1367
2257
1368
2258
while True:
1369
2259
if not client.enabled:
1370
2260
logger.info("Client %s is disabled",
1371
client.name)
2261
client.name)
1372
2262
if self.server.use_dbus:
1373
2263
# Emit D-Bus signal
1374
2264
client.Rejected("Disabled")
1375
2265
return
1376
1377
if client._approved or not client.approval_delay:
1378
#We are approved or approval is disabled
2266
2267
if client.approved or not client.approval_delay:
2268
# We are approved or approval is disabled
1379
2269
break
1380
elif client._approved is None:
2270
elif client.approved is None:
1381
2271
logger.info("Client %s needs approval",
1382
2272
client.name)
1383
2273
if self.server.use_dbus:
1384
2274
# Emit D-Bus signal
1385
2275
client.NeedApproval(
1386
client.approval_delay_milliseconds(),
1387
client.approved_by_default)
2276
client.approval_delay.total_seconds()
2277
* 1000, client.approved_by_default)
1388
2278
else:
1389
2279
logger.warning("Client %s was not approved",
1390
2280
client.name)
1392
2282
# Emit D-Bus signal
1393
2283
client.Rejected("Denied")
1394
2284
return
1395
1396
#wait until timeout or approved
2285
2286
# wait until timeout or approved
1397
2287
time = datetime.datetime.now()
1398
2288
client.changedstate.acquire()
1399
(client.changedstate.wait
1400
(float(client._timedelta_to_milliseconds(delay)
1401
/ 1000)))
2289
client.changedstate.wait(delay.total_seconds())
1402
2290
client.changedstate.release()
1403
2291
time2 = datetime.datetime.now()
1404
2292
if (time2 - time) >= delay:
1414
2302
break
1415
2303
else:
1416
2304
delay -= time2 - time
1417
1418
sent_size = 0
1419
while sent_size < len(client.secret):
1420
try:
1421
sent = session.send(client.secret[sent_size:])
1422
except gnutls.errors.GNUTLSError as error:
1423
logger.warning("gnutls send failed")
1424
return
1425
logger.debug("Sent: %d, remaining: %d",
1426
sent, len(client.secret)
1427
- (sent_size + sent))
1428
sent_size += sent
1429
2305
2306
try:
2307
session.send(client.secret)
2308
except gnutls.Error as error:
2309
logger.warning("gnutls send failed",
2310
exc_info=error)
2311
return
2312
1430
2313
logger.info("Sending secret to %s", client.name)
1431
2314
# bump the timeout using extended_timeout
1432
client.checked_ok(client.extended_timeout)
2315
client.bump_timeout(client.extended_timeout)
1433
2316
if self.server.use_dbus:
1434
2317
# Emit D-Bus signal
1435
2318
client.GotSecret()
1436
2319
1437
2320
finally:
1438
2321
if approval_required:
1439
2322
client.approvals_pending -= 1
1440
2323
try:
1441
2324
session.bye()
1442
except gnutls.errors.GNUTLSError as error:
1443
logger.warning("GnuTLS bye failed")
1444
2325
except gnutls.Error as error:
2326
logger.warning("GnuTLS bye failed",
2327
exc_info=error)
2328
1445
2329
@staticmethod
1446
2330
def peer_certificate(session):
1447
2331
"Return the peer's OpenPGP certificate as a bytestring"
1448
2332
# If not an OpenPGP certificate...
1449
if (gnutls.library.functions
1450
.gnutls_certificate_type_get(session._c_object)
1451
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1452
# ...do the normal thing
1453
return session.peer_certificate
2333
if (gnutls.certificate_type_get(session._c_object)
2334
!= gnutls.CRT_OPENPGP):
2335
# ...return invalid data
2336
return b""
1454
2337
list_size = ctypes.c_uint(1)
1455
cert_list = (gnutls.library.functions
1456
.gnutls_certificate_get_peers
2338
cert_list = (gnutls.certificate_get_peers
1457
2339
(session._c_object, ctypes.byref(list_size)))
1458
2340
if not bool(cert_list) and list_size.value != 0:
1459
raise gnutls.errors.GNUTLSError("error getting peer"
1460
" certificate")
2341
raise gnutls.Error("error getting peer certificate")
1461
2342
if list_size.value == 0:
1462
2343
return None
1463
2344
cert = cert_list[0]
1464
2345
return ctypes.string_at(cert.data, cert.size)
1465
2346
1466
2347
@staticmethod
1467
2348
def fingerprint(openpgp):
1468
2349
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1469
2350
# New GnuTLS "datum" with the OpenPGP public key
1470
datum = (gnutls.library.types
1471
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1472
ctypes.POINTER
1473
(ctypes.c_ubyte)),
1474
ctypes.c_uint(len(openpgp))))
2351
datum = gnutls.datum_t(
2352
ctypes.cast(ctypes.c_char_p(openpgp),
2353
ctypes.POINTER(ctypes.c_ubyte)),
2354
ctypes.c_uint(len(openpgp)))
1475
2355
# New empty GnuTLS certificate
1476
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1477
(gnutls.library.functions
1478
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2356
crt = gnutls.openpgp_crt_t()
2357
gnutls.openpgp_crt_init(ctypes.byref(crt))
1479
2358
# Import the OpenPGP public key into the certificate
1480
(gnutls.library.functions
1481
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1482
gnutls.library.constants
1483
.GNUTLS_OPENPGP_FMT_RAW))
2359
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2360
gnutls.OPENPGP_FMT_RAW)
1484
2361
# Verify the self signature in the key
1485
2362
crtverify = ctypes.c_uint()
1486
(gnutls.library.functions
1487
.gnutls_openpgp_crt_verify_self(crt, 0,
1488
ctypes.byref(crtverify)))
2363
gnutls.openpgp_crt_verify_self(crt, 0,
2364
ctypes.byref(crtverify))
1489
2365
if crtverify.value != 0:
1490
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1491
raise (gnutls.errors.CertificateSecurityError
1492
("Verify failed"))
2366
gnutls.openpgp_crt_deinit(crt)
2367
raise gnutls.CertificateSecurityError("Verify failed")
1493
2368
# New buffer for the fingerprint
1494
2369
buf = ctypes.create_string_buffer(20)
1495
2370
buf_len = ctypes.c_size_t()
1496
2371
# Get the fingerprint from the certificate into the buffer
1497
(gnutls.library.functions
1498
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1499
ctypes.byref(buf_len)))
2372
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2373
ctypes.byref(buf_len))
1500
2374
# Deinit the certificate
1501
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2375
gnutls.openpgp_crt_deinit(crt)
1502
2376
# Convert the buffer to a Python bytestring
1503
2377
fpr = ctypes.string_at(buf, buf_len.value)
1504
2378
# Convert the bytestring to hexadecimal notation
1505
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2379
hex_fpr = binascii.hexlify(fpr).upper()
1506
2380
return hex_fpr
1507
2381
1508
2382
1509
2383
class MultiprocessingMixIn(object):
1510
2384
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2385
1511
2386
def sub_process_main(self, request, address):
1512
2387
try:
1513
2388
self.finish_request(request, address)
1514
except:
2389
except Exception:
1515
2390
self.handle_error(request, address)
1516
2391
self.close_request(request)
1517
2392
1518
2393
def process_request(self, request, address):
1519
2394
"""Start a new process to process the request."""
1520
proc = multiprocessing.Process(target = self.sub_process_main,
1521
args = (request,
1522
address))
2395
proc = multiprocessing.Process(target=self.sub_process_main,
2396
args=(request, address))
1523
2397
proc.start()
1524
2398
return proc
1525
2399
1526
2400
1527
2401
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1528
2402
""" adds a pipe to the MixIn """
2403
1529
2404
def process_request(self, request, client_address):
1530
2405
"""Overrides and wraps the original process_request().
1531
2406
1532
2407
This function creates a new pipe in self.pipe
1533
2408
"""
1534
2409
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1535
2410
1536
2411
proc = MultiprocessingMixIn.process_request(self, request,
1537
2412
client_address)
1538
2413
self.child_pipe.close()
1539
2414
self.add_pipe(parent_pipe, proc)
1540
2415
1541
2416
def add_pipe(self, parent_pipe, proc):
1542
2417
"""Dummy function; override as necessary"""
1543
raise NotImplementedError
2418
raise NotImplementedError()
1544
2419
1545
2420
1546
2421
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1547
2422
socketserver.TCPServer, object):
1548
2423
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1549
2424
1550
2425
Attributes:
1551
2426
enabled: Boolean; whether this server is activated yet
1552
2427
interface: None or a network interface name (string)
1553
2428
use_ipv6: Boolean; to use IPv6 or not
1554
2429
"""
2430
1555
2431
def __init__(self, server_address, RequestHandlerClass,
1556
interface=None, use_ipv6=True):
2432
interface=None,
2433
use_ipv6=True,
2434
socketfd=None):
2435
"""If socketfd is set, use that file descriptor instead of
2436
creating a new one with socket.socket().
2437
"""
1557
2438
self.interface = interface
1558
2439
if use_ipv6:
1559
2440
self.address_family = socket.AF_INET6
2441
if socketfd is not None:
2442
# Save the file descriptor
2443
self.socketfd = socketfd
2444
# Save the original socket.socket() function
2445
self.socket_socket = socket.socket
2446
2447
# To implement --socket, we monkey patch socket.socket.
2448
#
2449
# (When socketserver.TCPServer is a new-style class, we
2450
# could make self.socket into a property instead of monkey
2451
# patching socket.socket.)
2452
#
2453
# Create a one-time-only replacement for socket.socket()
2454
@functools.wraps(socket.socket)
2455
def socket_wrapper(*args, **kwargs):
2456
# Restore original function so subsequent calls are
2457
# not affected.
2458
socket.socket = self.socket_socket
2459
del self.socket_socket
2460
# This time only, return a new socket object from the
2461
# saved file descriptor.
2462
return socket.fromfd(self.socketfd, *args, **kwargs)
2463
# Replace socket.socket() function with wrapper
2464
socket.socket = socket_wrapper
2465
# The socketserver.TCPServer.__init__ will call
2466
# socket.socket(), which might be our replacement,
2467
# socket_wrapper(), if socketfd was set.
1560
2468
socketserver.TCPServer.__init__(self, server_address,
1561
2469
RequestHandlerClass)
2470
1562
2471
def server_bind(self):
1563
2472
"""This overrides the normal server_bind() function
1564
2473
to bind to an interface if one was specified, and also NOT to
1565
2474
bind to an address or port if they were not specified."""
2475
global SO_BINDTODEVICE
1566
2476
if self.interface is not None:
1567
2477
if SO_BINDTODEVICE is None:
1568
logger.error("SO_BINDTODEVICE does not exist;"
1569
" cannot bind to interface %s",
1570
self.interface)
1571
else:
1572
try:
1573
self.socket.setsockopt(socket.SOL_SOCKET,
1574
SO_BINDTODEVICE,
1575
str(self.interface
1576
+ '\0'))
1577
except socket.error as error:
1578
if error[0] == errno.EPERM:
1579
logger.error("No permission to"
1580
" bind to interface %s",
1581
self.interface)
1582
elif error[0] == errno.ENOPROTOOPT:
1583
logger.error("SO_BINDTODEVICE not available;"
1584
" cannot bind to interface %s",
1585
self.interface)
1586
else:
1587
raise
2478
# Fall back to a hard-coded value which seems to be
2479
# common enough.
2480
logger.warning("SO_BINDTODEVICE not found, trying 25")
2481
SO_BINDTODEVICE = 25
2482
try:
2483
self.socket.setsockopt(
2484
socket.SOL_SOCKET, SO_BINDTODEVICE,
2485
(self.interface + "\0").encode("utf-8"))
2486
except socket.error as error:
2487
if error.errno == errno.EPERM:
2488
logger.error("No permission to bind to"
2489
" interface %s", self.interface)
2490
elif error.errno == errno.ENOPROTOOPT:
2491
logger.error("SO_BINDTODEVICE not available;"
2492
" cannot bind to interface %s",
2493
self.interface)
2494
elif error.errno == errno.ENODEV:
2495
logger.error("Interface %s does not exist,"
2496
" cannot bind", self.interface)
2497
else:
2498
raise
1588
2499
# Only bind(2) the socket if we really need to.
1589
2500
if self.server_address[0] or self.server_address[1]:
1590
2501
if not self.server_address[0]:
1591
2502
if self.address_family == socket.AF_INET6:
1592
any_address = "::" # in6addr_any
2503
any_address = "::" # in6addr_any
1593
2504
else:
1594
any_address = socket.INADDR_ANY
2505
any_address = "0.0.0.0" # INADDR_ANY
1595
2506
self.server_address = (any_address,
1596
2507
self.server_address[1])
1597
2508
elif not self.server_address[1]:
1598
self.server_address = (self.server_address[0],
1599
0)
2509
self.server_address = (self.server_address[0], 0)
1600
2510
# if self.interface:
1601
2511
# self.server_address = (self.server_address[0],
1602
2512
# 0, # port
1608
2518
1609
2519
class MandosServer(IPv6_TCPServer):
1610
2520
"""Mandos server.
1611
2521
1612
2522
Attributes:
1613
2523
clients: set of Client objects
1614
2524
gnutls_priority GnuTLS priority string
1615
2525
use_dbus: Boolean; to emit D-Bus signals or not
1616
1617
Assumes a gobject.MainLoop event loop.
2526
2527
Assumes a GLib.MainLoop event loop.
1618
2528
"""
2529
1619
2530
def __init__(self, server_address, RequestHandlerClass,
1620
interface=None, use_ipv6=True, clients=None,
1621
gnutls_priority=None, use_dbus=True):
2531
interface=None,
2532
use_ipv6=True,
2533
clients=None,
2534
gnutls_priority=None,
2535
use_dbus=True,
2536
socketfd=None):
1622
2537
self.enabled = False
1623
2538
self.clients = clients
1624
2539
if self.clients is None:
1625
self.clients = set()
2540
self.clients = {}
1626
2541
self.use_dbus = use_dbus
1627
2542
self.gnutls_priority = gnutls_priority
1628
2543
IPv6_TCPServer.__init__(self, server_address,
1629
2544
RequestHandlerClass,
1630
interface = interface,
1631
use_ipv6 = use_ipv6)
2545
interface=interface,
2546
use_ipv6=use_ipv6,
2547
socketfd=socketfd)
2548
1632
2549
def server_activate(self):
1633
2550
if self.enabled:
1634
2551
return socketserver.TCPServer.server_activate(self)
1635
2552
1636
2553
def enable(self):
1637
2554
self.enabled = True
1638
2555
1639
2556
def add_pipe(self, parent_pipe, proc):
1640
2557
# Call "handle_ipc" for both data and EOF events
1641
gobject.io_add_watch(parent_pipe.fileno(),
1642
gobject.IO_IN | gobject.IO_HUP,
1643
functools.partial(self.handle_ipc,
1644
parent_pipe =
1645
parent_pipe,
1646
proc = proc))
1647
1648
def handle_ipc(self, source, condition, parent_pipe=None,
1649
proc = None, client_object=None):
1650
condition_names = {
1651
gobject.IO_IN: "IN", # There is data to read.
1652
gobject.IO_OUT: "OUT", # Data can be written (without
1653
# blocking).
1654
gobject.IO_PRI: "PRI", # There is urgent data to read.
1655
gobject.IO_ERR: "ERR", # Error condition.
1656
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1657
# broken, usually for pipes and
1658
# sockets).
1659
}
1660
conditions_string = ' | '.join(name
1661
for cond, name in
1662
condition_names.iteritems()
1663
if cond & condition)
2558
GLib.io_add_watch(
2559
parent_pipe.fileno(),
2560
GLib.IO_IN | GLib.IO_HUP,
2561
functools.partial(self.handle_ipc,
2562
parent_pipe=parent_pipe,
2563
proc=proc))
2564
2565
def handle_ipc(self, source, condition,
2566
parent_pipe=None,
2567
proc=None,
2568
client_object=None):
1664
2569
# error, or the other end of multiprocessing.Pipe has closed
1665
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2570
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1666
2571
# Wait for other process to exit
1667
2572
proc.join()
1668
2573
return False
1669
2574
1670
2575
# Read a request from the child
1671
2576
request = parent_pipe.recv()
1672
2577
command = request[0]
1673
2578
1674
2579
if command == 'init':
1675
2580
fpr = request[1]
1676
2581
address = request[2]
1677
1678
for c in self.clients:
2582
2583
for c in self.clients.values():
1679
2584
if c.fingerprint == fpr:
1680
2585
client = c
1681
2586
break
1688
2593
address[0])
1689
2594
parent_pipe.send(False)
1690
2595
return False
1691
1692
gobject.io_add_watch(parent_pipe.fileno(),
1693
gobject.IO_IN | gobject.IO_HUP,
1694
functools.partial(self.handle_ipc,
1695
parent_pipe =
1696
parent_pipe,
1697
proc = proc,
1698
client_object =
1699
client))
2596
2597
GLib.io_add_watch(
2598
parent_pipe.fileno(),
2599
GLib.IO_IN | GLib.IO_HUP,
2600
functools.partial(self.handle_ipc,
2601
parent_pipe=parent_pipe,
2602
proc=proc,
2603
client_object=client))
1700
2604
parent_pipe.send(True)
1701
2605
# remove the old hook in favor of the new above hook on
1702
2606
# same fileno
1705
2609
funcname = request[1]
1706
2610
args = request[2]
1707
2611
kwargs = request[3]
1708
2612
1709
2613
parent_pipe.send(('data', getattr(client_object,
1710
2614
funcname)(*args,
1711
**kwargs)))
1712
2615
**kwargs)))
2616
1713
2617
if command == 'getattr':
1714
2618
attrname = request[1]
1715
if callable(client_object.__getattribute__(attrname)):
1716
parent_pipe.send(('function',))
2619
if isinstance(client_object.__getattribute__(attrname),
2620
collections.Callable):
2621
parent_pipe.send(('function', ))
1717
2622
else:
1718
parent_pipe.send(('data', client_object
1719
.__getattribute__(attrname)))
1720
2623
parent_pipe.send((
2624
'data', client_object.__getattribute__(attrname)))
2625
1721
2626
if command == 'setattr':
1722
2627
attrname = request[1]
1723
2628
value = request[2]
1724
2629
setattr(client_object, attrname, value)
1725
2630
1726
2631
return True
1727
2632
1728
2633
2634
def rfc3339_duration_to_delta(duration):
2635
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2636
2637
>>> rfc3339_duration_to_delta("P7D")
2638
datetime.timedelta(7)
2639
>>> rfc3339_duration_to_delta("PT60S")
2640
datetime.timedelta(0, 60)
2641
>>> rfc3339_duration_to_delta("PT60M")
2642
datetime.timedelta(0, 3600)
2643
>>> rfc3339_duration_to_delta("PT24H")
2644
datetime.timedelta(1)
2645
>>> rfc3339_duration_to_delta("P1W")
2646
datetime.timedelta(7)
2647
>>> rfc3339_duration_to_delta("PT5M30S")
2648
datetime.timedelta(0, 330)
2649
>>> rfc3339_duration_to_delta("P1DT3M20S")
2650
datetime.timedelta(1, 200)
2651
"""
2652
2653
# Parsing an RFC 3339 duration with regular expressions is not
2654
# possible - there would have to be multiple places for the same
2655
# values, like seconds. The current code, while more esoteric, is
2656
# cleaner without depending on a parsing library. If Python had a
2657
# built-in library for parsing we would use it, but we'd like to
2658
# avoid excessive use of external libraries.
2659
2660
# New type for defining tokens, syntax, and semantics all-in-one
2661
Token = collections.namedtuple("Token", (
2662
"regexp", # To match token; if "value" is not None, must have
2663
# a "group" containing digits
2664
"value", # datetime.timedelta or None
2665
"followers")) # Tokens valid after this token
2666
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2667
# the "duration" ABNF definition in RFC 3339, Appendix A.
2668
token_end = Token(re.compile(r"$"), None, frozenset())
2669
token_second = Token(re.compile(r"(\d+)S"),
2670
datetime.timedelta(seconds=1),
2671
frozenset((token_end, )))
2672
token_minute = Token(re.compile(r"(\d+)M"),
2673
datetime.timedelta(minutes=1),
2674
frozenset((token_second, token_end)))
2675
token_hour = Token(re.compile(r"(\d+)H"),
2676
datetime.timedelta(hours=1),
2677
frozenset((token_minute, token_end)))
2678
token_time = Token(re.compile(r"T"),
2679
None,
2680
frozenset((token_hour, token_minute,
2681
token_second)))
2682
token_day = Token(re.compile(r"(\d+)D"),
2683
datetime.timedelta(days=1),
2684
frozenset((token_time, token_end)))
2685
token_month = Token(re.compile(r"(\d+)M"),
2686
datetime.timedelta(weeks=4),
2687
frozenset((token_day, token_end)))
2688
token_year = Token(re.compile(r"(\d+)Y"),
2689
datetime.timedelta(weeks=52),
2690
frozenset((token_month, token_end)))
2691
token_week = Token(re.compile(r"(\d+)W"),
2692
datetime.timedelta(weeks=1),
2693
frozenset((token_end, )))
2694
token_duration = Token(re.compile(r"P"), None,
2695
frozenset((token_year, token_month,
2696
token_day, token_time,
2697
token_week)))
2698
# Define starting values:
2699
# Value so far
2700
value = datetime.timedelta()
2701
found_token = None
2702
# Following valid tokens
2703
followers = frozenset((token_duration, ))
2704
# String left to parse
2705
s = duration
2706
# Loop until end token is found
2707
while found_token is not token_end:
2708
# Search for any currently valid tokens
2709
for token in followers:
2710
match = token.regexp.match(s)
2711
if match is not None:
2712
# Token found
2713
if token.value is not None:
2714
# Value found, parse digits
2715
factor = int(match.group(1), 10)
2716
# Add to value so far
2717
value += factor * token.value
2718
# Strip token from string
2719
s = token.regexp.sub("", s, 1)
2720
# Go to found token
2721
found_token = token
2722
# Set valid next tokens
2723
followers = found_token.followers
2724
break
2725
else:
2726
# No currently valid tokens were found
2727
raise ValueError("Invalid RFC 3339 duration: {!r}"
2728
.format(duration))
2729
# End token found
2730
return value
2731
2732
1729
2733
def string_to_delta(interval):
1730
2734
"""Parse a string and return a datetime.timedelta
1731
2735
1732
2736
>>> string_to_delta('7d')
1733
2737
datetime.timedelta(7)
1734
2738
>>> string_to_delta('60s')
1742
2746
>>> string_to_delta('5m 30s')
1743
2747
datetime.timedelta(0, 330)
1744
2748
"""
2749
2750
try:
2751
return rfc3339_duration_to_delta(interval)
2752
except ValueError:
2753
pass
2754
1745
2755
timevalue = datetime.timedelta(0)
1746
2756
for s in interval.split():
1747
2757
try:
1748
suffix = unicode(s[-1])
2758
suffix = s[-1]
1749
2759
value = int(s[:-1])
1750
2760
if suffix == "d":
1751
2761
delta = datetime.timedelta(value)
1758
2768
elif suffix == "w":
1759
2769
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1760
2770
else:
1761
raise ValueError("Unknown suffix %r" % suffix)
1762
except (ValueError, IndexError) as e:
2771
raise ValueError("Unknown suffix {!r}".format(suffix))
2772
except IndexError as e:
1763
2773
raise ValueError(*(e.args))
1764
2774
timevalue += delta
1765
2775
return timevalue
1766
2776
1767
2777
1768
def if_nametoindex(interface):
1769
"""Call the C function if_nametoindex(), or equivalent
1770
1771
Note: This function cannot accept a unicode string."""
1772
global if_nametoindex
1773
try:
1774
if_nametoindex = (ctypes.cdll.LoadLibrary
1775
(ctypes.util.find_library("c"))
1776
.if_nametoindex)
1777
except (OSError, AttributeError):
1778
logger.warning("Doing if_nametoindex the hard way")
1779
def if_nametoindex(interface):
1780
"Get an interface index the hard way, i.e. using fcntl()"
1781
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1782
with contextlib.closing(socket.socket()) as s:
1783
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1784
struct.pack(str("16s16x"),
1785
interface))
1786
interface_index = struct.unpack(str("I"),
1787
ifreq[16:20])[0]
1788
return interface_index
1789
return if_nametoindex(interface)
1790
1791
1792
def daemon(nochdir = False, noclose = False):
2778
def daemon(nochdir=False, noclose=False):
1793
2779
"""See daemon(3). Standard BSD Unix function.
1794
2780
1795
2781
This should really exist as os.daemon, but it doesn't (yet)."""
1796
2782
if os.fork():
1797
2783
sys.exit()
1802
2788
sys.exit()
1803
2789
if not noclose:
1804
2790
# Close all standard open file descriptors
1805
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2791
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1806
2792
if not stat.S_ISCHR(os.fstat(null).st_mode):
1807
2793
raise OSError(errno.ENODEV,
1808
"%s not a character device"
1809
% os.path.devnull)
2794
"{} not a character device"
2795
.format(os.devnull))
1810
2796
os.dup2(null, sys.stdin.fileno())
1811
2797
os.dup2(null, sys.stdout.fileno())
1812
2798
os.dup2(null, sys.stderr.fileno())
1815
2801
1816
2802
1817
2803
def main():
1818
2804
1819
2805
##################################################################
1820
2806
# Parsing of options, both command line and config file
1821
2807
1822
2808
parser = argparse.ArgumentParser()
1823
2809
parser.add_argument("-v", "--version", action="version",
1824
version = "%%(prog)s %s" % version,
2810
version="%(prog)s {}".format(version),
1825
2811
help="show version number and exit")
1826
2812
parser.add_argument("-i", "--interface", metavar="IF",
1827
2813
help="Bind to interface IF")
1833
2819
help="Run self-test")
1834
2820
parser.add_argument("--debug", action="store_true",
1835
2821
help="Debug mode; run in foreground and log"
1836
" to terminal")
2822
" to terminal", default=None)
1837
2823
parser.add_argument("--debuglevel", metavar="LEVEL",
1838
2824
help="Debug level for stdout output")
1839
2825
parser.add_argument("--priority", help="GnuTLS"
1846
2832
" files")
1847
2833
parser.add_argument("--no-dbus", action="store_false",
1848
2834
dest="use_dbus", help="Do not provide D-Bus"
1849
" system bus interface")
2835
" system bus interface", default=None)
1850
2836
parser.add_argument("--no-ipv6", action="store_false",
1851
dest="use_ipv6", help="Do not use IPv6")
2837
dest="use_ipv6", help="Do not use IPv6",
2838
default=None)
2839
parser.add_argument("--no-restore", action="store_false",
2840
dest="restore", help="Do not restore stored"
2841
" state", default=None)
2842
parser.add_argument("--socket", type=int,
2843
help="Specify a file descriptor to a network"
2844
" socket to use instead of creating one")
2845
parser.add_argument("--statedir", metavar="DIR",
2846
help="Directory to save/restore state in")
2847
parser.add_argument("--foreground", action="store_true",
2848
help="Run in foreground", default=None)
2849
parser.add_argument("--no-zeroconf", action="store_false",
2850
dest="zeroconf", help="Do not use Zeroconf",
2851
default=None)
2852
1852
2853
options = parser.parse_args()
1853
2854
1854
2855
if options.check:
1855
2856
import doctest
1856
doctest.testmod()
1857
sys.exit()
1858
2857
fail_count, test_count = doctest.testmod()
2858
sys.exit(os.EX_OK if fail_count == 0 else 1)
2859
1859
2860
# Default values for config file for server-global settings
1860
server_defaults = { "interface": "",
1861
"address": "",
1862
"port": "",
1863
"debug": "False",
1864
"priority":
1865
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1866
"servicename": "Mandos",
1867
"use_dbus": "True",
1868
"use_ipv6": "True",
1869
"debuglevel": "",
1870
}
1871
2861
server_defaults = {"interface": "",
2862
"address": "",
2863
"port": "",
2864
"debug": "False",
2865
"priority":
2866
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2867
":+SIGN-DSA-SHA256",
2868
"servicename": "Mandos",
2869
"use_dbus": "True",
2870
"use_ipv6": "True",
2871
"debuglevel": "",
2872
"restore": "True",
2873
"socket": "",
2874
"statedir": "/var/lib/mandos",
2875
"foreground": "False",
2876
"zeroconf": "True",
2877
}
2878
1872
2879
# Parse config file for server-global settings
1873
2880
server_config = configparser.SafeConfigParser(server_defaults)
1874
2881
del server_defaults
1875
server_config.read(os.path.join(options.configdir,
1876
"mandos.conf"))
2882
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1877
2883
# Convert the SafeConfigParser object to a dict
1878
2884
server_settings = server_config.defaults()
1879
2885
# Use the appropriate methods on the non-string config options
1880
for option in ("debug", "use_dbus", "use_ipv6"):
2886
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1881
2887
server_settings[option] = server_config.getboolean("DEFAULT",
1882
2888
option)
1883
2889
if server_settings["port"]:
1884
2890
server_settings["port"] = server_config.getint("DEFAULT",
1885
2891
"port")
2892
if server_settings["socket"]:
2893
server_settings["socket"] = server_config.getint("DEFAULT",
2894
"socket")
2895
# Later, stdin will, and stdout and stderr might, be dup'ed
2896
# over with an opened os.devnull. But we don't want this to
2897
# happen with a supplied network socket.
2898
if 0 <= server_settings["socket"] <= 2:
2899
server_settings["socket"] = os.dup(server_settings
2900
["socket"])
1886
2901
del server_config
1887
2902
1888
2903
# Override the settings from the config file with command line
1889
2904
# options, if set.
1890
2905
for option in ("interface", "address", "port", "debug",
1891
"priority", "servicename", "configdir",
1892
"use_dbus", "use_ipv6", "debuglevel"):
2906
"priority", "servicename", "configdir", "use_dbus",
2907
"use_ipv6", "debuglevel", "restore", "statedir",
2908
"socket", "foreground", "zeroconf"):
1893
2909
value = getattr(options, option)
1894
2910
if value is not None:
1895
2911
server_settings[option] = value
1896
2912
del options
1897
2913
# Force all strings to be unicode
1898
2914
for option in server_settings.keys():
1899
if type(server_settings[option]) is str:
1900
server_settings[option] = unicode(server_settings[option])
2915
if isinstance(server_settings[option], bytes):
2916
server_settings[option] = (server_settings[option]
2917
.decode("utf-8"))
2918
# Force all boolean options to be boolean
2919
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2920
"foreground", "zeroconf"):
2921
server_settings[option] = bool(server_settings[option])
2922
# Debug implies foreground
2923
if server_settings["debug"]:
2924
server_settings["foreground"] = True
1901
2925
# Now we have our good server settings in "server_settings"
1902
2926
1903
2927
##################################################################
1904
2928
2929
if (not server_settings["zeroconf"]
2930
and not (server_settings["port"]
2931
or server_settings["socket"] != "")):
2932
parser.error("Needs port or socket to work without Zeroconf")
2933
1905
2934
# For convenience
1906
2935
debug = server_settings["debug"]
1907
2936
debuglevel = server_settings["debuglevel"]
1908
2937
use_dbus = server_settings["use_dbus"]
1909
2938
use_ipv6 = server_settings["use_ipv6"]
1910
2939
stored_state_path = os.path.join(server_settings["statedir"],
2940
stored_state_file)
2941
foreground = server_settings["foreground"]
2942
zeroconf = server_settings["zeroconf"]
2943
2944
if debug:
2945
initlogger(debug, logging.DEBUG)
2946
else:
2947
if not debuglevel:
2948
initlogger(debug)
2949
else:
2950
level = getattr(logging, debuglevel.upper())
2951
initlogger(debug, level)
2952
1911
2953
if server_settings["servicename"] != "Mandos":
1912
syslogger.setFormatter(logging.Formatter
1913
('Mandos (%s) [%%(process)d]:'
1914
' %%(levelname)s: %%(message)s'
1915
% server_settings["servicename"]))
1916
2954
syslogger.setFormatter(
2955
logging.Formatter('Mandos ({}) [%(process)d]:'
2956
' %(levelname)s: %(message)s'.format(
2957
server_settings["servicename"])))
2958
1917
2959
# Parse config file with clients
1918
client_defaults = { "timeout": "5m",
1919
"extended_timeout": "15m",
1920
"interval": "2m",
1921
"checker": "fping -q -- %%(host)s",
1922
"host": "",
1923
"approval_delay": "0s",
1924
"approval_duration": "1s",
1925
}
1926
client_config = configparser.SafeConfigParser(client_defaults)
2960
client_config = configparser.SafeConfigParser(Client
2961
.client_defaults)
1927
2962
client_config.read(os.path.join(server_settings["configdir"],
1928
2963
"clients.conf"))
1929
2964
1930
2965
global mandos_dbus_service
1931
2966
mandos_dbus_service = None
1932
1933
tcp_server = MandosServer((server_settings["address"],
1934
server_settings["port"]),
1935
ClientHandler,
1936
interface=(server_settings["interface"]
1937
or None),
1938
use_ipv6=use_ipv6,
1939
gnutls_priority=
1940
server_settings["priority"],
1941
use_dbus=use_dbus)
1942
if not debug:
1943
pidfilename = "/var/run/mandos.pid"
1944
try:
1945
pidfile = open(pidfilename, "w")
1946
except IOError:
1947
logger.error("Could not open file %r", pidfilename)
1948
1949
try:
1950
uid = pwd.getpwnam("_mandos").pw_uid
1951
gid = pwd.getpwnam("_mandos").pw_gid
1952
except KeyError:
1953
try:
1954
uid = pwd.getpwnam("mandos").pw_uid
1955
gid = pwd.getpwnam("mandos").pw_gid
2967
2968
socketfd = None
2969
if server_settings["socket"] != "":
2970
socketfd = server_settings["socket"]
2971
tcp_server = MandosServer(
2972
(server_settings["address"], server_settings["port"]),
2973
ClientHandler,
2974
interface=(server_settings["interface"] or None),
2975
use_ipv6=use_ipv6,
2976
gnutls_priority=server_settings["priority"],
2977
use_dbus=use_dbus,
2978
socketfd=socketfd)
2979
if not foreground:
2980
pidfilename = "/run/mandos.pid"
2981
if not os.path.isdir("/run/."):
2982
pidfilename = "/var/run/mandos.pid"
2983
pidfile = None
2984
try:
2985
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2986
except IOError as e:
2987
logger.error("Could not open file %r", pidfilename,
2988
exc_info=e)
2989
2990
for name, group in (("_mandos", "_mandos"),
2991
("mandos", "mandos"),
2992
("nobody", "nogroup")):
2993
try:
2994
uid = pwd.getpwnam(name).pw_uid
2995
gid = pwd.getpwnam(group).pw_gid
2996
break
1956
2997
except KeyError:
1957
try:
1958
uid = pwd.getpwnam("nobody").pw_uid
1959
gid = pwd.getpwnam("nobody").pw_gid
1960
except KeyError:
1961
uid = 65534
1962
gid = 65534
2998
continue
2999
else:
3000
uid = 65534
3001
gid = 65534
1963
3002
try:
1964
3003
os.setgid(gid)
1965
3004
os.setuid(uid)
3005
if debug:
3006
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3007
gid))
1966
3008
except OSError as error:
1967
if error[0] != errno.EPERM:
1968
raise error
1969
1970
if not debug and not debuglevel:
1971
syslogger.setLevel(logging.WARNING)
1972
console.setLevel(logging.WARNING)
1973
if debuglevel:
1974
level = getattr(logging, debuglevel.upper())
1975
syslogger.setLevel(level)
1976
console.setLevel(level)
1977
3009
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3010
.format(uid, gid, os.strerror(error.errno)))
3011
if error.errno != errno.EPERM:
3012
raise
3013
1978
3014
if debug:
1979
3015
# Enable all possible GnuTLS debugging
1980
3016
1981
3017
# "Use a log level over 10 to enable all debugging options."
1982
3018
# - GnuTLS manual
1983
gnutls.library.functions.gnutls_global_set_log_level(11)
1984
1985
@gnutls.library.types.gnutls_log_func
3019
gnutls.global_set_log_level(11)
3020
3021
@gnutls.log_func
1986
3022
def debug_gnutls(level, string):
1987
3023
logger.debug("GnuTLS: %s", string[:-1])
1988
1989
(gnutls.library.functions
1990
.gnutls_global_set_log_function(debug_gnutls))
1991
3024
3025
gnutls.global_set_log_function(debug_gnutls)
3026
1992
3027
# Redirect stdin so all checkers get /dev/null
1993
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3028
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1994
3029
os.dup2(null, sys.stdin.fileno())
1995
3030
if null > 2:
1996
3031
os.close(null)
1997
else:
1998
# No console logging
1999
logger.removeHandler(console)
2000
3032
2001
3033
# Need to fork before connecting to D-Bus
2002
if not debug:
3034
if not foreground:
2003
3035
# Close all input and output, do double fork, etc.
2004
3036
daemon()
2005
3037
3038
# multiprocessing will use threads, so before we use GLib we need
3039
# to inform GLib that threads will be used.
3040
GLib.threads_init()
3041
2006
3042
global main_loop
2007
3043
# From the Avahi example code
2008
DBusGMainLoop(set_as_default=True )
2009
main_loop = gobject.MainLoop()
3044
DBusGMainLoop(set_as_default=True)
3045
main_loop = GLib.MainLoop()
2010
3046
bus = dbus.SystemBus()
2011
3047
# End of Avahi example code
2012
3048
if use_dbus:
2013
3049
try:
2014
3050
bus_name = dbus.service.BusName("se.recompile.Mandos",
2015
bus, do_not_queue=True)
2016
old_bus_name = (dbus.service.BusName
2017
("se.bsnet.fukt.Mandos", bus,
2018
do_not_queue=True))
2019
except dbus.exceptions.NameExistsException as e:
2020
logger.error(unicode(e) + ", disabling D-Bus")
3051
bus,
3052
do_not_queue=True)
3053
old_bus_name = dbus.service.BusName(
3054
"se.bsnet.fukt.Mandos", bus,
3055
do_not_queue=True)
3056
except dbus.exceptions.DBusException as e:
3057
logger.error("Disabling D-Bus:", exc_info=e)
2021
3058
use_dbus = False
2022
3059
server_settings["use_dbus"] = False
2023
3060
tcp_server.use_dbus = False
2024
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2025
service = AvahiService(name = server_settings["servicename"],
2026
servicetype = "_mandos._tcp",
2027
protocol = protocol, bus = bus)
2028
if server_settings["interface"]:
2029
service.interface = (if_nametoindex
2030
(str(server_settings["interface"])))
2031
3061
if zeroconf:
3062
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3063
service = AvahiServiceToSyslog(
3064
name=server_settings["servicename"],
3065
servicetype="_mandos._tcp",
3066
protocol=protocol,
3067
bus=bus)
3068
if server_settings["interface"]:
3069
service.interface = if_nametoindex(
3070
server_settings["interface"].encode("utf-8"))
3071
2032
3072
global multiprocessing_manager
2033
3073
multiprocessing_manager = multiprocessing.Manager()
2034
3074
2035
3075
client_class = Client
2036
3076
if use_dbus:
2037
client_class = functools.partial(ClientDBusTransitional,
2038
bus = bus)
2039
def client_config_items(config, section):
2040
special_settings = {
2041
"approved_by_default":
2042
lambda: config.getboolean(section,
2043
"approved_by_default"),
2044
}
2045
for name, value in config.items(section):
3077
client_class = functools.partial(ClientDBus, bus=bus)
3078
3079
client_settings = Client.config_parser(client_config)
3080
old_client_settings = {}
3081
clients_data = {}
3082
3083
# This is used to redirect stdout and stderr for checker processes
3084
global wnull
3085
wnull = open(os.devnull, "w") # A writable /dev/null
3086
# Only used if server is running in foreground but not in debug
3087
# mode
3088
if debug or not foreground:
3089
wnull.close()
3090
3091
# Get client data and settings from last running state.
3092
if server_settings["restore"]:
3093
try:
3094
with open(stored_state_path, "rb") as stored_state:
3095
if sys.version_info.major == 2:
3096
clients_data, old_client_settings = pickle.load(
3097
stored_state)
3098
else:
3099
bytes_clients_data, bytes_old_client_settings = (
3100
pickle.load(stored_state, encoding="bytes"))
3101
# Fix bytes to strings
3102
# clients_data
3103
# .keys()
3104
clients_data = {(key.decode("utf-8")
3105
if isinstance(key, bytes)
3106
else key): value
3107
for key, value in
3108
bytes_clients_data.items()}
3109
del bytes_clients_data
3110
for key in clients_data:
3111
value = {(k.decode("utf-8")
3112
if isinstance(k, bytes) else k): v
3113
for k, v in
3114
clients_data[key].items()}
3115
clients_data[key] = value
3116
# .client_structure
3117
value["client_structure"] = [
3118
(s.decode("utf-8")
3119
if isinstance(s, bytes)
3120
else s) for s in
3121
value["client_structure"]]
3122
# .name & .host
3123
for k in ("name", "host"):
3124
if isinstance(value[k], bytes):
3125
value[k] = value[k].decode("utf-8")
3126
# old_client_settings
3127
# .keys()
3128
old_client_settings = {
3129
(key.decode("utf-8")
3130
if isinstance(key, bytes)
3131
else key): value
3132
for key, value in
3133
bytes_old_client_settings.items()}
3134
del bytes_old_client_settings
3135
# .host
3136
for value in old_client_settings.values():
3137
if isinstance(value["host"], bytes):
3138
value["host"] = (value["host"]
3139
.decode("utf-8"))
3140
os.remove(stored_state_path)
3141
except IOError as e:
3142
if e.errno == errno.ENOENT:
3143
logger.warning("Could not load persistent state:"
3144
" {}".format(os.strerror(e.errno)))
3145
else:
3146
logger.critical("Could not load persistent state:",
3147
exc_info=e)
3148
raise
3149
except EOFError as e:
3150
logger.warning("Could not load persistent state: "
3151
"EOFError:",
3152
exc_info=e)
3153
3154
with PGPEngine() as pgp:
3155
for client_name, client in clients_data.items():
3156
# Skip removed clients
3157
if client_name not in client_settings:
3158
continue
3159
3160
# Decide which value to use after restoring saved state.
3161
# We have three different values: Old config file,
3162
# new config file, and saved state.
3163
# New config value takes precedence if it differs from old
3164
# config value, otherwise use saved state.
3165
for name, value in client_settings[client_name].items():
3166
try:
3167
# For each value in new config, check if it
3168
# differs from the old config value (Except for
3169
# the "secret" attribute)
3170
if (name != "secret"
3171
and (value !=
3172
old_client_settings[client_name][name])):
3173
client[name] = value
3174
except KeyError:
3175
pass
3176
3177
# Clients who has passed its expire date can still be
3178
# enabled if its last checker was successful. A Client
3179
# whose checker succeeded before we stored its state is
3180
# assumed to have successfully run all checkers during
3181
# downtime.
3182
if client["enabled"]:
3183
if datetime.datetime.utcnow() >= client["expires"]:
3184
if not client["last_checked_ok"]:
3185
logger.warning(
3186
"disabling client {} - Client never "
3187
"performed a successful checker".format(
3188
client_name))
3189
client["enabled"] = False
3190
elif client["last_checker_status"] != 0:
3191
logger.warning(
3192
"disabling client {} - Client last"
3193
" checker failed with error code"
3194
" {}".format(
3195
client_name,
3196
client["last_checker_status"]))
3197
client["enabled"] = False
3198
else:
3199
client["expires"] = (
3200
datetime.datetime.utcnow()
3201
+ client["timeout"])
3202
logger.debug("Last checker succeeded,"
3203
" keeping {} enabled".format(
3204
client_name))
2046
3205
try:
2047
yield (name, special_settings[name]())
2048
except KeyError:
2049
yield (name, value)
2050
2051
tcp_server.clients.update(set(
2052
client_class(name = section,
2053
config= dict(client_config_items(
2054
client_config, section)))
2055
for section in client_config.sections()))
3206
client["secret"] = pgp.decrypt(
3207
client["encrypted_secret"],
3208
client_settings[client_name]["secret"])
3209
except PGPError:
3210
# If decryption fails, we use secret from new settings
3211
logger.debug("Failed to decrypt {} old secret".format(
3212
client_name))
3213
client["secret"] = (client_settings[client_name]
3214
["secret"])
3215
3216
# Add/remove clients based on new changes made to config
3217
for client_name in (set(old_client_settings)
3218
- set(client_settings)):
3219
del clients_data[client_name]
3220
for client_name in (set(client_settings)
3221
- set(old_client_settings)):
3222
clients_data[client_name] = client_settings[client_name]
3223
3224
# Create all client objects
3225
for client_name, client in clients_data.items():
3226
tcp_server.clients[client_name] = client_class(
3227
name=client_name,
3228
settings=client,
3229
server_settings=server_settings)
3230
2056
3231
if not tcp_server.clients:
2057
3232
logger.warning("No clients defined")
2058
2059
if not debug:
2060
try:
2061
with pidfile:
2062
pid = os.getpid()
2063
pidfile.write(str(pid) + "\n".encode("utf-8"))
2064
del pidfile
2065
except IOError:
2066
logger.error("Could not write to file %r with PID %d",
2067
pidfilename, pid)
2068
except NameError:
2069
# "pidfile" was never created
2070
pass
3233
3234
if not foreground:
3235
if pidfile is not None:
3236
pid = os.getpid()
3237
try:
3238
with pidfile:
3239
print(pid, file=pidfile)
3240
except IOError:
3241
logger.error("Could not write to file %r with PID %d",
3242
pidfilename, pid)
3243
del pidfile
2071
3244
del pidfilename
2072
2073
signal.signal(signal.SIGINT, signal.SIG_IGN)
2074
2075
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2076
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2077
3245
3246
for termsig in (signal.SIGHUP, signal.SIGTERM):
3247
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3248
lambda: main_loop.quit() and False)
3249
2078
3250
if use_dbus:
2079
class MandosDBusService(dbus.service.Object):
3251
3252
@alternate_dbus_interfaces(
3253
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3254
class MandosDBusService(DBusObjectWithObjectManager):
2080
3255
"""A D-Bus proxy object"""
3256
2081
3257
def __init__(self):
2082
3258
dbus.service.Object.__init__(self, bus, "/")
3259
2083
3260
_interface = "se.recompile.Mandos"
2084
3261
2085
3262
@dbus.service.signal(_interface, signature="o")
2086
3263
def ClientAdded(self, objpath):
2087
3264
"D-Bus signal"
2088
3265
pass
2089
3266
2090
3267
@dbus.service.signal(_interface, signature="ss")
2091
3268
def ClientNotFound(self, fingerprint, address):
2092
3269
"D-Bus signal"
2093
3270
pass
2094
3271
3272
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3273
"true"})
2095
3274
@dbus.service.signal(_interface, signature="os")
2096
3275
def ClientRemoved(self, objpath, name):
2097
3276
"D-Bus signal"
2098
3277
pass
2099
3278
3279
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3280
"true"})
2100
3281
@dbus.service.method(_interface, out_signature="ao")
2101
3282
def GetAllClients(self):
2102
3283
"D-Bus method"
2103
return dbus.Array(c.dbus_object_path
2104
for c in tcp_server.clients)
2105
3284
return dbus.Array(c.dbus_object_path for c in
3285
tcp_server.clients.values())
3286
3287
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3288
"true"})
2106
3289
@dbus.service.method(_interface,
2107
3290
out_signature="a{oa{sv}}")
2108
3291
def GetAllClientsWithProperties(self):
2109
3292
"D-Bus method"
2110
3293
return dbus.Dictionary(
2111
((c.dbus_object_path, c.GetAll(""))
2112
for c in tcp_server.clients),
3294
{c.dbus_object_path: c.GetAll(
3295
"se.recompile.Mandos.Client")
3296
for c in tcp_server.clients.values()},
2113
3297
signature="oa{sv}")
2114
3298
2115
3299
@dbus.service.method(_interface, in_signature="o")
2116
3300
def RemoveClient(self, object_path):
2117
3301
"D-Bus method"
2118
for c in tcp_server.clients:
3302
for c in tcp_server.clients.values():
2119
3303
if c.dbus_object_path == object_path:
2120
tcp_server.clients.remove(c)
3304
del tcp_server.clients[c.name]
2121
3305
c.remove_from_connection()
2122
# Don't signal anything except ClientRemoved
3306
# Don't signal the disabling
2123
3307
c.disable(quiet=True)
2124
# Emit D-Bus signal
2125
self.ClientRemoved(object_path, c.name)
3308
# Emit D-Bus signal for removal
3309
self.client_removed_signal(c)
2126
3310
return
2127
3311
raise KeyError(object_path)
2128
3312
2129
3313
del _interface
2130
2131
class MandosDBusServiceTransitional(MandosDBusService):
2132
__metaclass__ = AlternateDBusNamesMetaclass
2133
mandos_dbus_service = MandosDBusServiceTransitional()
2134
3314
3315
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3316
out_signature="a{oa{sa{sv}}}")
3317
def GetManagedObjects(self):
3318
"""D-Bus method"""
3319
return dbus.Dictionary(
3320
{client.dbus_object_path:
3321
dbus.Dictionary(
3322
{interface: client.GetAll(interface)
3323
for interface in
3324
client._get_all_interface_names()})
3325
for client in tcp_server.clients.values()})
3326
3327
def client_added_signal(self, client):
3328
"""Send the new standard signal and the old signal"""
3329
if use_dbus:
3330
# New standard signal
3331
self.InterfacesAdded(
3332
client.dbus_object_path,
3333
dbus.Dictionary(
3334
{interface: client.GetAll(interface)
3335
for interface in
3336
client._get_all_interface_names()}))
3337
# Old signal
3338
self.ClientAdded(client.dbus_object_path)
3339
3340
def client_removed_signal(self, client):
3341
"""Send the new standard signal and the old signal"""
3342
if use_dbus:
3343
# New standard signal
3344
self.InterfacesRemoved(
3345
client.dbus_object_path,
3346
client._get_all_interface_names())
3347
# Old signal
3348
self.ClientRemoved(client.dbus_object_path,
3349
client.name)
3350
3351
mandos_dbus_service = MandosDBusService()
3352
3353
# Save modules to variables to exempt the modules from being
3354
# unloaded before the function registered with atexit() is run.
3355
mp = multiprocessing
3356
wn = wnull
3357
2135
3358
def cleanup():
2136
3359
"Cleanup function; run on exit"
2137
service.cleanup()
2138
2139
multiprocessing.active_children()
3360
if zeroconf:
3361
service.cleanup()
3362
3363
mp.active_children()
3364
wn.close()
3365
if not (tcp_server.clients or client_settings):
3366
return
3367
3368
# Store client before exiting. Secrets are encrypted with key
3369
# based on what config file has. If config file is
3370
# removed/edited, old secret will thus be unrecovable.
3371
clients = {}
3372
with PGPEngine() as pgp:
3373
for client in tcp_server.clients.values():
3374
key = client_settings[client.name]["secret"]
3375
client.encrypted_secret = pgp.encrypt(client.secret,
3376
key)
3377
client_dict = {}
3378
3379
# A list of attributes that can not be pickled
3380
# + secret.
3381
exclude = {"bus", "changedstate", "secret",
3382
"checker", "server_settings"}
3383
for name, typ in inspect.getmembers(dbus.service
3384
.Object):
3385
exclude.add(name)
3386
3387
client_dict["encrypted_secret"] = (client
3388
.encrypted_secret)
3389
for attr in client.client_structure:
3390
if attr not in exclude:
3391
client_dict[attr] = getattr(client, attr)
3392
3393
clients[client.name] = client_dict
3394
del client_settings[client.name]["secret"]
3395
3396
try:
3397
with tempfile.NamedTemporaryFile(
3398
mode='wb',
3399
suffix=".pickle",
3400
prefix='clients-',
3401
dir=os.path.dirname(stored_state_path),
3402
delete=False) as stored_state:
3403
pickle.dump((clients, client_settings), stored_state,
3404
protocol=2)
3405
tempname = stored_state.name
3406
os.rename(tempname, stored_state_path)
3407
except (IOError, OSError) as e:
3408
if not debug:
3409
try:
3410
os.remove(tempname)
3411
except NameError:
3412
pass
3413
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3414
logger.warning("Could not save persistent state: {}"
3415
.format(os.strerror(e.errno)))
3416
else:
3417
logger.warning("Could not save persistent state:",
3418
exc_info=e)
3419
raise
3420
3421
# Delete all clients, and settings from config
2140
3422
while tcp_server.clients:
2141
client = tcp_server.clients.pop()
3423
name, client = tcp_server.clients.popitem()
2142
3424
if use_dbus:
2143
3425
client.remove_from_connection()
2144
client.disable_hook = None
2145
# Don't signal anything except ClientRemoved
3426
# Don't signal the disabling
2146
3427
client.disable(quiet=True)
3428
# Emit D-Bus signal for removal
2147
3429
if use_dbus:
2148
# Emit D-Bus signal
2149
mandos_dbus_service.ClientRemoved(client
2150
.dbus_object_path,
2151
client.name)
2152
3430
mandos_dbus_service.client_removed_signal(client)
3431
client_settings.clear()
3432
2153
3433
atexit.register(cleanup)
2154
2155
for client in tcp_server.clients:
3434
3435
for client in tcp_server.clients.values():
2156
3436
if use_dbus:
2157
# Emit D-Bus signal
2158
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2159
client.enable()
2160
3437
# Emit D-Bus signal for adding
3438
mandos_dbus_service.client_added_signal(client)
3439
# Need to initiate checking of clients
3440
if client.enabled:
3441
client.init_checker()
3442
2161
3443
tcp_server.enable()
2162
3444
tcp_server.server_activate()
2163
3445
2164
3446
# Find out what port we got
2165
service.port = tcp_server.socket.getsockname()[1]
3447
if zeroconf:
3448
service.port = tcp_server.socket.getsockname()[1]
2166
3449
if use_ipv6:
2167
3450
logger.info("Now listening on address %r, port %d,"
2168
" flowinfo %d, scope_id %d"
2169
% tcp_server.socket.getsockname())
3451
" flowinfo %d, scope_id %d",
3452
*tcp_server.socket.getsockname())
2170
3453
else: # IPv4
2171
logger.info("Now listening on address %r, port %d"
2172
% tcp_server.socket.getsockname())
2173
2174
#service.interface = tcp_server.socket.getsockname()[3]
2175
3454
logger.info("Now listening on address %r, port %d",
3455
*tcp_server.socket.getsockname())
3456
3457
# service.interface = tcp_server.socket.getsockname()[3]
3458
2176
3459
try:
2177
# From the Avahi example code
2178
try:
2179
service.activate()
2180
except dbus.exceptions.DBusException as error:
2181
logger.critical("DBusException: %s", error)
2182
cleanup()
2183
sys.exit(1)
2184
# End of Avahi example code
2185
2186
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2187
lambda *args, **kwargs:
2188
(tcp_server.handle_request
2189
(*args[2:], **kwargs) or True))
2190
3460
if zeroconf:
3461
# From the Avahi example code
3462
try:
3463
service.activate()
3464
except dbus.exceptions.DBusException as error:
3465
logger.critical("D-Bus Exception", exc_info=error)
3466
cleanup()
3467
sys.exit(1)
3468
# End of Avahi example code
3469
3470
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3471
lambda *args, **kwargs:
3472
(tcp_server.handle_request
3473
(*args[2:], **kwargs) or True))
3474
2191
3475
logger.debug("Starting main loop")
2192
3476
main_loop.run()
2193
3477
except AvahiError as error:
2194
logger.critical("AvahiError: %s", error)
3478
logger.critical("Avahi Error", exc_info=error)
2195
3479
cleanup()
2196
3480
sys.exit(1)
2197
3481
except KeyboardInterrupt:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0