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