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