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