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