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