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