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