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