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