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