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