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