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