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