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