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