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