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