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