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