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