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