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