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