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