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