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