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