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