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