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