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