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