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