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