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