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