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