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