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