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