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