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