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