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